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