App-upf
view release on metacpan or search on metacpan
=head1 SYNOPSIS
Usage:
% upf add-delete-user-groups [--add-to-json=s] [--add-to=s+]
[--config-path=path | -c] [--config-profile=profile | -P]
[--delete-from-json=s] [--delete-from=s+] [--etc-dir=s]
[--format=name] [--json] [--(no)naked-res] [--no-config | -C]
[--no-env] [--page-result[=program]] <user>
% upf add-group [--backup] [--config-path=path | -c]
[--config-profile=profile | -P] [--etc-dir=s] [--format=name]
[--gid=s] [--json] [--max-gid=s] [--members-json=s] [--members=s]
[--min-gid=s] [--(no)naked-res] [--no-backup] [--no-config | -C]
[--no-env] [--nobackup] [--page-result[=program]] <group>
% upf add-user [--backup] [--config-path=path | -c]
[--config-profile=profile | -P] [--encpass=s] [--etc-dir=s]
[--expire-date=s] [--format=name] [--gecos=s] [--gid=s] [--group=s]
[--home=s] [--json] [--last-pwchange=s] [--max-gid=s]
[--max-pass-age=s] [--max-uid=s] [--min-gid=s] [--min-pass-age=s]
[--min-uid=s] [--(no)naked-res] [--no-backup] [--no-config | -C]
[--no-env] [--nobackup] [--page-result[=program]]
[--pass-inactive-period=s] [--pass-warn-period=s] [--pass=s]
[--shell=s] [--uid=s] <user>
% upf add-user-to-group [--config-path=path | -c]
[--config-profile=profile | -P] [--etc-dir=s] [--format=name] [--json]
[--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] <user> <group>
% upf delete-group [--backup] [--config-path=path | -c]
[--config-profile=profile | -P] [--etc-dir=s] [--format=name] [--json]
[--(no)naked-res] [--no-backup] [--no-config | -C] [--no-env]
[--nobackup] [--page-result[=program]] <group>
% upf delete-user [--backup] [--config-path=path | -c]
[--config-profile=profile | -P] [--etc-dir=s] [--format=name] [--json]
[--(no)naked-res] [--no-backup] [--no-config | -C] [--no-env]
[--nobackup] [--page-result[=program]] <user>
% upf delete-user-from-group [--config-path=path | -c]
[--config-profile=profile | -P] [--etc-dir=s] [--format=name] [--json]
[--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] <user> <group>
% upf get-group [--config-path=path | -c] [--config-profile=profile | -P]
[--etc-dir=s] [--format=name] [--gid=s] [--group=s] [--json]
[--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] [--with-field-names] [--without-field-names]
% upf get-max-gid [--config-path=path | -c] [--config-profile=profile |
-P] [--etc-dir=s] [--format=name] [--json] [--(no)naked-res]
[--without-field-names]
% upf list-users [--config-path=path | -c] [--config-profile=profile | -P]
[--detail] [--etc-dir=s] [--format=name] [--json] [--(no)naked-res]
[--no-config | -C] [--no-detail] [--no-env] [--nodetail]
[--page-result[=program]] [--with-field-names] [--without-field-names]
% upf list-users-and-groups [--config-path=path | -c]
[--config-profile=profile | -P] [--detail] [--etc-dir=s]
[--format=name] [--json] [--(no)naked-res] [--no-config | -C]
[--no-detail] [--no-env] [--nodetail] [--page-result[=program]]
[--with-field-names] [--without-field-names]
% upf modify-group [--admins=s] [--backup] [--config-path=path | -c]
[--config-profile=profile | -P] [--encpass=s] [--etc-dir=s]
[--format=name] [--gid=s] [--json] [--members=s] [--(no)naked-res]
[--no-backup] [--no-config | -C] [--no-env] [--nobackup]
[--page-result[=program]] [--pass=s] <group>
% upf modify-user [--backup] [--config-path=path | -c]
[--config-profile=profile | -P] [--encpass=s] [--etc-dir=s]
[--expire-date=s] [--format=name] [--gecos=s] [--gid=s] [--home=s]
[--json] [--last-pwchange=s] [--max-pass-age=s] [--min-pass-age=s]
[--(no)naked-res] [--no-backup] [--no-config | -C] [--no-env]
[--nobackup] [--page-result[=program]] [--pass-inactive-period=s]
[--pass-warn-period=s] [--shell=s] [--uid=s] <user>
% upf set-user-groups [--config-path=path | -c] [--config-profile=profile
| -P] [--etc-dir=s] [--format=name] [--json] [--(no)naked-res]
[--no-config | -C] [--no-env] [--page-result[=program]] <user>
<groups> ...
% upf set-user-password [--backup] [--config-path=path | -c]
[--config-profile=profile | -P] [--etc-dir=s] [--format=name] [--json]
[--(no)naked-res] [--no-backup] [--no-config | -C] [--no-env]
[--nobackup] [--page-result[=program]] <user> <pass>
% upf user-exists [--config-path=path | -c] [--config-profile=profile |
-P] [--etc-dir=s] [--format=name] [--json] [--(no)naked-res]
[--no-config | -C] [--no-env] [--page-result[=program]] [--uid=s]
[--user=s]
=head1 SUBCOMMANDS
=head2 B<add-delete-user-groups>
Add or delete user from one or several groups.
Can be specified multiple times.
=item B<--user>=I<s>*
=back
=head2 Options for subcommand add-group
=over
=item B<--backup>
Whether to backup when modifying files.
Backup is written with `.bak` extension in the same directory. Unmodified file
will not be backed up. Previous backup will be overwritten.
=item B<--gid>=I<s>
Pick a specific new GID.
Adding a new group with duplicate GID is allowed.
=item B<--group>=I<s>*
If a free GID between `min_gid` and `max_gid` is not found, error 412 is
returned.
=back
=head2 Options for subcommand add-user
=over
=item B<--backup>
Whether to backup when modifying files.
Backup is written with `.bak` extension in the same directory. Unmodified file
will not be backed up. Previous backup will be overwritten.
=item B<--encpass>=I<s>
Encrypted password.
=item B<--expire-date>=I<s>
The date of expiration of the account, expressed as the number of days since Jan 1, 1970.
=item B<--group>=I<s>*
=item B<--user>=I<s>*
=back
=head2 Options for subcommand delete-group
=over
=item B<--backup>
Whether to backup when modifying files.
Backup is written with `.bak` extension in the same directory. Unmodified file
will not be backed up. Previous backup will be overwritten.
=item B<--group>=I<s>*
=back
=head2 Options for subcommand delete-user
=over
=item B<--backup>
Whether to backup when modifying files.
Backup is written with `.bak` extension in the same directory. Unmodified file
will not be backed up. Previous backup will be overwritten.
=item B<--user>=I<s>*
=back
=head2 Options for subcommand delete-user-from-group
=over
=back
=head2 Options for subcommand modify-group
=over
=item B<--admins>=I<s>
It must be a comma-separated list of user names, or empty.
=item B<--backup>
Whether to backup when modifying files.
Backup is written with `.bak` extension in the same directory. Unmodified file
will not be backed up. Previous backup will be overwritten.
=item B<--encpass>=I<s>
Encrypted password.
=item B<--gid>=I<s>
Numeric group ID.
=item B<--pass>=I<s>
Password, generally should be "x" which means password is encrypted in gshadow.
=back
=head2 Options for subcommand modify-user
=over
=item B<--backup>
Whether to backup when modifying files.
Backup is written with `.bak` extension in the same directory. Unmodified file
will not be backed up. Previous backup will be overwritten.
=item B<--encpass>=I<s>
Encrypted password.
=item B<--expire-date>=I<s>
The date of expiration of the account, expressed as the number of days since Jan 1, 1970.
Can be specified multiple times.
=item B<--user>=I<s>*
=back
=head2 Options for subcommand set-user-password
=over
=item B<--backup>
Whether to backup when modifying files.
Backup is written with `.bak` extension in the same directory. Unmodified file
will not be backed up. Previous backup will be overwritten.
=item B<--pass>=I<s>*
=item B<--user>=I<s>*
=back
=head2 Options for subcommand user-exists
naked_res (see --naked-res)
=head2 Configuration for subcommand add-delete-user-groups
add_to (see --add-to)
delete_from (see --delete-from)
user (see --user)
=head2 Configuration for subcommand add-group
backup (see --backup)
gid (see --gid)
group (see --group)
max_gid (see --max-gid)
members (see --members)
min_gid (see --min-gid)
=head2 Configuration for subcommand add-user
backup (see --backup)
encpass (see --encpass)
expire_date (see --expire-date)
gecos (see --gecos)
gid (see --gid)
group (see --group)
home (see --home)
last_pwchange (see --last-pwchange)
max_gid (see --max-gid)
max_pass_age (see --max-pass-age)
max_uid (see --max-uid)
uid (see --uid)
user (see --user)
=head2 Configuration for subcommand add-user-to-group
group (see --group)
user (see --user)
=head2 Configuration for subcommand delete-group
backup (see --backup)
group (see --group)
=head2 Configuration for subcommand delete-user
backup (see --backup)
user (see --user)
=head2 Configuration for subcommand delete-user-from-group
group (see --group)
user (see --user)
=head2 Configuration for subcommand get-group
gid (see --gid)
with_field_names (see --without-field-names)
=head2 Configuration for subcommand list-users-and-groups
detail (see --detail)
with_field_names (see --without-field-names)
=head2 Configuration for subcommand modify-group
admins (see --admins)
backup (see --backup)
encpass (see --encpass)
gid (see --gid)
group (see --group)
members (see --members)
pass (see --pass)
=head2 Configuration for subcommand modify-user
backup (see --backup)
encpass (see --encpass)
expire_date (see --expire-date)
gecos (see --gecos)
gid (see --gid)
home (see --home)
last_pwchange (see --last-pwchange)
max_pass_age (see --max-pass-age)
min_pass_age (see --min-pass-age)
pass_inactive_period (see --pass-inactive-period)
pass_warn_period (see --pass-warn-period)
uid (see --uid)
user (see --user)
=head2 Configuration for subcommand set-user-groups
groups (see --groups)
user (see --user)
=head2 Configuration for subcommand set-user-password
backup (see --backup)
pass (see --pass)
user (see --user)
=head2 Configuration for subcommand user-exists
uid (see --uid)
user (see --user)
=head1 ENVIRONMENT
( run in 0.464 second using v1.01-cache-2.11-cpan-49f99fa48dc )