Russ Allbery e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00

130 lines
3.6 KiB
Plaintext

=head1 NAME
uss - Introduction to the uss command suite
=head1 DESCRIPTION
The commands in the uss command suite help administrators to
create AFS user accounts more easily and efficiently. If B<uss>
commands are not used, creating an account requires issuing at least six
separate commands to five different AFS servers.
There are three main commands in the suite:
=over 4
=item *
The uss add command creates a single complete user account,
based on command line arguments and instructions in a template file.
=item *
The uss bulk command creates multiple complete accounts at
once, based on command line arguments, instructions in a template file and a
bulk input file.
=item *
the uss delete command removes most parts of a user
account.
=back
To obtain help, issue the B<uss apropos> and uss help
commands.
=head1 OPTIONS
The following arguments and flags are available on many commands in the
B<uss> suite. The reference page for each command also lists
them, but they are described here in greater detail.
=over 4
=item -admin <I<administrator to authenticate>
>
Specifies the AFS user name under which to establish a connection to the
AFS server processes that administer the various parts of a user
account. If it is omitted, the connection is established under the
issuer's effective user ID (his or her identity in the local file
system). Even when this argument is included, UNIX commands that run
during the B<uss> operation (for instance, the UNIX
B</etc/chown> command) run under the effective user ID.
=item -cell <I<cell name>
>
Names the cell in which to run the command. It is acceptable to
abbreviate the cell name to the shortest form that distinguishes it from the
other entries in the B</usr/vice/etc/CellServDB> file on the local
machine. If the B<-cell> argument is omitted, the command
interpreter determines the name of the local cell by reading the following in
order:
=item *
The value of the AFSCELL environment variable
=item *
The local /usr/vice/etc/ThisCell file
=item -dryrun
Reports actions that the command interpreter needs to perform when
executing the B<uss> operation, without actually performing
them. Include this flag to verify that the command produces the desired
account configuration. Combine it with the B<-verbose> flag to
yield even more detailed information. Note that the output does not
necessarily reveal all possible problems that can prevent successful execution
of the command, especially those that result from transient server or network
outages.
=item -help
Prints a command's online help message on the standard output
stream. Do not combine this flag with any of the command's other
options; when it is provided, the command interpreter ignores all other
options, and only prints the help message.
=item -skipauth
Bypasses mutual authentication with the AFS Authentication Server,
allowing a site that uses Kerberos instead of the AFS Authentication Server to
substitute that form of authentication.
=back
=head1 PRIVILEGE REQUIRED
The issuer of a uss command must have all the rights required
for performing the equivalent actions individually. See each
B<uss> command's reference page.
=head1 SEE ALSO
L<uss Bulk Input File(1)>
L<uss Template File(1)>
L<uss_add(1)>,
L<uss_apropos(1)>,
L<uss_bulk(1)>,
L<uss_delete(1)>,
L<uss_help(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.