ocserv/src/ocpasswd-args.def

AutoGen Definitions options;
prog-name     = ocpasswd;
prog-title    = "OpenConnect server password utility";
prog-desc     = "OpenConnect VPN server plain password file handling program.";
disable-save;
no-xlate = opt;
gnu-usage;
config-header = config.h;
long-opts;
no-misuse-usage;
short-usage   = "Usage: ocpasswd -c [passwd] [options] username\nocpasswd --help for usage instructions.\n";
explain       = "";
reorder-args;
argument      = "[username]";
#include version.inc

detail  = "This program is openconnect password (ocpasswd) utility. It allows the generation
and handling of a 'plain' password file used by ocserv.";

copyright = {
    date  = "2013, 2014";
    owner = "Nikos Mavrogiannopoulos";
    author = "Nikos Mavrogiannopoulos";
    eaddr  = "openconnect-devel@lists.infradead.org";
    type  = gplv2;
};

flag = {
    name      = passwd;
    value     = c;
    arg-type  = file;
    descrip   = "Password file";
    doc   = "";
};

flag = {
    name      = groupname;
    value     = g;
    arg-type  = string;
    descrip   = "User's group name";
    doc   = "";
};

flag = {
    name      = delete;
    value     = d;
    descrip   = "Delete user";
    doc   = "Removes the specified user from the password file";
};

flag = {
    name      = lock;
    value     = l;
    descrip   = "Lock user";
    doc   = "Prevents the specified user from logging in";
};

flag = {
    name      = unlock;
    value     = u;
    descrip   = "Unlock user";
    doc   = "Re-enables login for the specified user";
};

help-value    = h;


doc-section = {
  ds-type = 'FILES';
  ds-format = 'texi';
  ds-text   = <<-_EOT_
@subheading Password file format
The password format of ocpasswd is as follows.

@example
username:groupname:encoded-password
@end example

The crypt(3) encoding is used for the encoded-password.

_EOT_;
};

doc-section = {
  ds-type = 'EXAMPLES';
  ds-format = 'texi';
  ds-text   = <<-_EOT_
@subheading Adding a user
@example
$ ocpasswd -c ocpasswd my_username
@end example

@subheading Locking a user
@example
$ ocpasswd -c ocpasswd -l my_username
@end example

@subheading Unlocking a user
@example
$ ocpasswd -c ocpasswd -u my_username
@end example
_EOT_;
};

doc-section = {
  ds-type   = 'SEE ALSO';
  ds-format = 'man';
  ds-text   = <<-_EOText_
ocserv(8), occtl(8)
_EOText_;
};