man-page-misc-improvements-20051221
[openafs.git] / doc / man-pages / pod1 / livesys.pod
1 =head1 NAME
2
3 livesys - Reports the configured CPU/operating system type
4
5 =head1 SYNOPSIS
6
7 B<livesys>
8
9 =head1 DESCRIPTION
10
11 The B<livesys> command displays the string stored in kernel memory that
12 indicates the local machine's CPU/operating system (OS) type,
13 conventionally called the I<sysname>.  The Cache Manager substitutes this
14 string for the I<@sys> variable which can occur in AFS pathnames; the
15 I<IBM AFS Quick Beginnings> and I<IBM AFS Administration Guide> explain
16 how using I<@sys> can simplify cell configuration.
17
18 To set a new value in kernel memory, use the B<fs sysname> command, which
19 can also be used to view the current value.  If a sysname list was set
20 using B<fs sysname>, only the first value in the list will be reported by
21 B<livesys>.
22
23 =head1 CAUTIONS
24
25 To see the full sysname list, use B<fs sysname> rather than this command.
26 B<livesys> is mostly useful for scripts that need to know the primary
27 sysname for the local system (to create directories that will later be
28 addressed using I<@sys>, for example).
29
30 B<livesys> first appeared in OpenAFS 1.2.2.  Scripts that need to support
31 older versions of AFS should parse the output of B<fs sysname> or use
32 B<sys>.
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 Linux system with a
43 2.6 kernel:
44
45    % livesys
46    i386_linux26
47
48 =head1 PRIVILEGE REQUIRED
49
50 None
51
52 =head1 SEE ALSO
53
54 L<fs_sysname(1)>,
55 L<sys(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 Copyright 2005 Russ Allbery <rra@stanford.edu>
66
67 This documentation is covered by the IBM Public License Version 1.0.  It
68 was written by Russ Allbery based on the B<sys> man page.