xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect5 / UserList.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="UserList5">
3   <refmeta>
4     <refentrytitle>UserList</refentrytitle>
5     <manvolnum>5</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>UserList</refname>
9     <refpurpose>Defines privileged administrators</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Description</title>
13     <para>The <replaceable>UserList</replaceable> file lists the AFS usernames of the system administrators
14     authorized to issue privileged <emphasis role="bold">bos</emphasis>, <emphasis role="bold">vos</emphasis>, and <emphasis role="bold">backup</emphasis> commands that
15     affect the local server machine or the volumes housed on it. It must
16     reside in the <replaceable>/usr/afs/etc</replaceable> directory on every server machine.</para>
17
18     <para>Although the <replaceable>UserList</replaceable> file is in ASCII format, do not use a text editor
19     to alter it. Instead always use the appropriate commands from the <emphasis role="bold">bos</emphasis>
20     command suite:</para>
21
22     <itemizedlist>
23       <listitem>
24         <para>The <emphasis role="bold">bos adduser</emphasis> command to add a user to the file.</para>
25
26       </listitem>
27       <listitem>
28         <para>The <emphasis role="bold">bos listusers</emphasis> command to display the contents of the file.</para>
29
30       </listitem>
31       <listitem>
32         <para>The <emphasis role="bold">bos removeuser</emphasis> command to remove a user from the file.</para>
33
34       </listitem>
35     </itemizedlist>
36     <para>Although it is theoretically possible to list different administrators in
37     the <replaceable>UserList</replaceable> files on different server machines, doing so can cause
38     unanticipated authorization failures and is not recommended. In cells that
39     use the Update Server to distribute the contents of the <replaceable>/usr/afs/etc</replaceable>
40     directory, it is customary to edit only the copy of the file stored on the
41     system control machine. Otherwise, edit the file on each server machine
42     individually.</para>
43
44   </refsect1>
45   <refsect1>
46     <title>See Also</title>
47     <para><link linkend="bos_adduser8">bos_adduser(8)</link>,
48     <link linkend="bos_listusers8">bos_listusers(8)</link>,
49     <link linkend="bos_removeuser8">bos_removeuser(8)</link>,
50     <link linkend="upclient8">upclient(8)</link>,
51     <link linkend="upserver8">upserver(8)</link></para>
52
53   </refsect1>
54   <refsect1>
55     <title>Copyright</title>
56     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
57
58     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
59     converted from HTML to POD by software written by Chas Williams and Russ
60     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
61
62   </refsect1>
63 </refentry>