man-page-name-underscore-20071111
[openafs.git] / doc / man-pages / pod1 / fs_sysname.pod
1 =head1 NAME
2
3 fs_sysname - Reports or sets the CPU/operating system type
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs sysname> S<<< [B<-newsys> <I<new sysname>>] >>> [B<-help>]
11
12 B<fs sy> S<<< [B<-n> <I<new sysname>>] >>> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs sysname> command sets or displays the local machine's
20 CPU/operating system type as recorded in kernel memory. The Cache Manager
21 substitutes the string for the I<@sys> variable which can occur in AFS
22 pathnames; the I<IBM AFS Quick Beginnings> and I<IBM AFS Administration
23 Guide> explain how using I<@sys> can simplify cell configuration. It is
24 best to use it sparingly, however, because it can make the effect of
25 changing directories unpredictable.
26
27 The command always applies to the local machine only. If issued on an NFS
28 client machine accessing AFS via the NFS/AFS Translator, the string is set
29 or reported for the NFS client machine. The Cache Manager on the AFS
30 client machine serving as the NFS client's NFS/AFS translator machine
31 stores the value in its kernel memory, and so can provide the NFS client
32 with the proper version of program binaries when the user issues commands
33 for which the pathname to the binaries includes I<@sys>. There is a
34 separate record for each user logged into the NFS client, which implies
35 that if a user adopts a new identity (UNIX UID) during a login session on
36 the NFS client -- perhaps by using the UNIX B<su> command -- he or she
37 must verify that the correct string is set for the new identity also.
38
39 =head1 OPTIONS
40
41 =over 4
42
43 =item B<-newsys> <I<new sysname>>
44
45 Sets the CPU/operating system indicator string for the local machine. If
46 this argument is omitted, the output displays the current setting
47 instead. AFS uses a standardized set of strings; consult the I<IBM AFS
48 Quick Beginnings> or I<AFS Release Notes>.
49
50 =item B<-help>
51
52 Prints the online help for this command. All other valid options are
53 ignored.
54
55 =back
56
57 =head1 OUTPUT
58
59 When the B<-newsys> argument is omitted, the output reports the machine's
60 system type in the following format:
61
62    Current sysname is '<system_type>'
63
64 =head1 EXAMPLES
65
66 The following example shows the output produced on a Sun SPARCStation
67 running Solaris 5.7:
68
69    % fs sysname
70    Current sysname is 'sun4x_57'
71
72 The following command defines a machine to be a IBM RS/6000 running AIX
73 4.2:
74
75    % fs sysname -newsys rs_aix42
76
77 =head1 PRIVILEGE REQUIRED
78
79 To display the current setting, no privilege is required. To include the
80 B<-newsys> argument on an AFS client machine, the issuer must be logged in
81 as the local superuser C<root>.
82
83 =head1 SEE ALSO
84
85 L<fs_exportafs(1)>,
86 L<sys(1)>
87
88 I<IBM AFS Quick Beginnings>
89
90 I<IBM AFS Administration Guide>
91
92 =head1 COPYRIGHT
93
94 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
95
96 This documentation is covered by the IBM Public License Version 1.0.  It was
97 converted from HTML to POD by software written by Chas Williams and Russ
98 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.