xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect1 / fs_sysname.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="fs_sysname1">
3   <refmeta>
4     <refentrytitle>fs sysname</refentrytitle>
5     <manvolnum>1</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>fs sysname</refname>
9     <refpurpose>Reports or sets the CPU/operating system type</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">fs sysname</emphasis> [<emphasis role="bold">-newsys</emphasis> &lt;<emphasis>new sysname</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
14
15     <para><emphasis role="bold">fs sy</emphasis> [<emphasis role="bold">-n</emphasis> &lt;<emphasis>new sysname</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
16
17   </refsect1>
18   <refsect1>
19     <title>Description</title>
20     <para>The <emphasis role="bold">fs sysname</emphasis> command sets or displays the local machine's
21     CPU/operating system type as recorded in kernel memory. The Cache Manager
22     substitutes the string for the <emphasis>@sys</emphasis> variable which can occur in AFS
23     pathnames; the <emphasis>IBM AFS Quick Beginnings</emphasis> and <emphasis>IBM AFS Administration
24     Guide</emphasis> explain how using <emphasis>@sys</emphasis> can simplify cell configuration. It is
25     best to use it sparingly, however, because it can make the effect of
26     changing directories unpredictable.</para>
27
28     <para>The command always applies to the local machine only. If issued on an NFS
29     client machine accessing AFS via the NFS/AFS Translator, the string is set
30     or reported for the NFS client machine. The Cache Manager on the AFS
31     client machine serving as the NFS client's NFS/AFS translator machine
32     stores the value in its kernel memory, and so can provide the NFS client
33     with the proper version of program binaries when the user issues commands
34     for which the pathname to the binaries includes <emphasis>@sys</emphasis>. There is a
35     separate record for each user logged into the NFS client, which implies
36     that if a user adopts a new identity (UNIX UID) during a login session on
37     the NFS client -- perhaps by using the UNIX <emphasis role="bold">su</emphasis> command -- he or she
38     must verify that the correct string is set for the new identity also.</para>
39
40   </refsect1>
41   <refsect1>
42     <title>Options</title>
43     <variablelist>
44       <varlistentry>
45         <term><emphasis role="bold">-newsys</emphasis> &lt;<emphasis>new sysname</emphasis>&gt;</term>
46         <listitem>
47           <para>Sets the CPU/operating system indicator string for the local machine. If
48           this argument is omitted, the output displays the current setting
49           instead. AFS uses a standardized set of strings; consult the <emphasis>IBM AFS
50           Quick Beginnings</emphasis> or <emphasis>AFS Release Notes</emphasis>.</para>
51
52         </listitem>
53       </varlistentry>
54       <varlistentry>
55         <term><emphasis role="bold">-help</emphasis></term>
56         <listitem>
57           <para>Prints the online help for this command. All other valid options are
58           ignored.</para>
59
60         </listitem>
61       </varlistentry>
62     </variablelist>
63   </refsect1>
64   <refsect1>
65     <title>Output</title>
66     <para>When the <emphasis role="bold">-newsys</emphasis> argument is omitted, the output reports the machine's
67     system type in the following format:</para>
68
69 <programlisting>
70    Current sysname is '&amp;lt;system_type&amp;gt;'
71
72 </programlisting>
73     </refsect1>
74     <refsect1>
75       <title>Examples</title>
76       <para>The following example shows the output produced on a Sun SPARCStation
77       running Solaris 5.7:</para>
78
79 <programlisting>
80    % fs sysname
81    Current sysname is 'sun4x_57'
82
83 </programlisting>
84         <para>The following command defines a machine to be a IBM RS/6000 running AIX
85         4.2:</para>
86
87 <programlisting>
88    % fs sysname -newsys rs_aix42
89
90 </programlisting>
91         </refsect1>
92         <refsect1>
93           <title>Privilege Required</title>
94           <para>To display the current setting, no privilege is required. To include the
95           <emphasis role="bold">-newsys</emphasis> argument on an AFS client machine, the issuer must be logged in
96           as the local superuser <computeroutput>root</computeroutput>.</para>
97
98         </refsect1>
99         <refsect1>
100           <title>See Also</title>
101           <para><link linkend="fs_exportafs1">fs_exportafs(1)</link>,
102           <link linkend="sys1">sys(1)</link></para>
103
104           <para><emphasis>IBM AFS Quick Beginnings</emphasis></para>
105
106           <para><emphasis>IBM AFS Administration Guide</emphasis></para>
107
108         </refsect1>
109         <refsect1>
110           <title>Copyright</title>
111           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
112
113           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
114           converted from HTML to POD by software written by Chas Williams and Russ
115           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
116
117         </refsect1>
118       </refentry>