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