man-page-misc-updates-20071225
[openafs.git] / doc / man-pages / pod1 / sys.pod
1 =head1 NAME
2
3 sys - Reports the compile-time CPU/operating system type
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<sys>
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The B<sys> command displays the string set at compile time that indicates
18 the local machine's CPU/operating system (OS) type, conventionally called
19 the I<sysname>.  This string is the default for the value stored in kernel
20 memory.  The Cache Manager substitutes this string for the I<@sys>
21 variable which can occur in AFS pathnames; the I<IBM AFS Quick Beginnings>
22 and I<IBM AFS Administration Guide> explain how using I<@sys> can simplify
23 cell configuration.
24
25 To set a new value in kernel memory, use the B<fs sysname> command.  To
26 view the current value set in the kernel, use either B<fs sysname> or
27 B<livesys>.
28
29 =head1 CAUTIONS
30
31 You almost always want to use B<livesys> rather than this command.  The
32 B<sys> command displays a single value hard-coded at compile time.  It
33 does not query the Cache Manager for the current value and it does not
34 report sysname lists.  If you have changed the local system type with B<fs
35 sysname>, or if you run a version of B<sys> compiled differently than the
36 Cache Manager running on the system, the value retured will not match the
37 behavior of the Cache Manager.  The only reason to use B<sys> is that
38 B<livesys> wasn't available in older versions of AFS.
39
40 =head1 OUTPUT
41
42 The machine's system type appears as a text string:
43
44    I<system_type>
45
46 =head1 EXAMPLES
47
48 The following example shows the output produced on a Sun SPARCStation
49 running Solaris 5.7:
50
51    % sys
52    sun4x_57
53
54 =head1 PRIVILEGE REQUIRED
55
56 None
57
58 =head1 SEE ALSO
59
60 L<fs_sysname(1)>,
61 L<livesys(1)>
62
63 I<OpenAFS Quick Beginnings>
64
65 I<OpenAFS Administration Guide>
66
67 =head1 COPYRIGHT
68
69 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
70
71 This documentation is covered by the IBM Public License Version 1.0.  It was
72 converted from HTML to POD by software written by Chas Williams and Russ
73 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.