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