NAME

upf-add-user - Add a new user

VERSION

This document describes version 0.060 of upf-add-user (from Perl distribution App-UpfUtils), released on 2020-04-29.

SYNOPSIS

Usage:

 % upf-add-user [--backup] [--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] [--nobackup] [--page-result[=program]]
     [--pass-inactive-period=s] [--pass-warn-period=s] [--pass=s]
     [--shell=s] [--uid=s] <user>

OPTIONS

* marks required options.

Main options

--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.

--encpass=s

Encrypted password.

--expire-date=s

The date of expiration of the account, expressed as the number of days since Jan 1, 1970.

--gecos=s

Usually, it contains the full username.

--gid=s

Pick a specific GID when creating group.

Duplicate GID is allowed.

--group=s

Select primary group (default is group with same name as user).

Normally, a user's primary group with group with the same name as user, which will be created if does not already exist. You can pick another group here, which must already exist (and in this case, the group with the same name as user will not be created).

--home=s

User's home directory.

--last-pwchange=s

The date of the last password change, expressed as the number of days since Jan 1, 1970..

--max-gid=s

Pick a range for GID when creating group.

--max-pass-age=s

The number of days after which the user will have to change her password.

--max-uid=s

Pick a range for new UID.

Default value:

 65535

If a free UID between `min_uid` and `max_uid` is not found, error 412 is returned.

--min-gid=s

Pick a range for GID when creating group.

--min-pass-age=s

The number of days the user will have to wait before she will be allowed to change her password again.

--min-uid=s

Pick a range for new UID.

Default value:

 1000

If a free UID between `min_uid` and `max_uid` is not found, error 412 is returned.

--pass-inactive-period=s

The number of days after a password has expired (see max_pass_age) during which the password should still be accepted (and user should update her password during the next login).

--pass-warn-period=s

The number of days before a password is going to expire (see max_pass_age) during which the user should be warned.

--pass=s

Password, generally should be "x" which means password is encrypted in shadow.

--shell=s

User's shell.

--uid=s

Pick a specific new UID.

Adding a new user with duplicate UID is allowed.

--user=s*

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

 undef

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]

--page-result

Filter output through a pager.

Other options

--etc-dir=s

Specify location of passwd files.

Default value:

 "/etc"

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C upf-add-user upf-add-user

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete upf-add-user 'p/*/`upf-add-user`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-UpfUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-UpfUtils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-UpfUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2016, 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm App::UpfUtils

perl -MCPAN -e shell
install App::UpfUtils