doc: fs examine no longer requires read rights on the volume root vnode
[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 =for html
8 <div class="synopsis">
9
10 B<livesys>
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The B<livesys> command displays the string stored in kernel memory that
18 indicates the local machine's CPU/operating system (OS) type,
19 conventionally called the I<sysname>.  The Cache Manager substitutes this
20 string for the I<@sys> variable which can occur in AFS pathnames; the
21 I<OpenAFS Quick Start Guides> and I<OpenAFS Administration Guide> explain
22 how using I<@sys> can simplify cell configuration.
23
24 To set a new value in kernel memory, use the B<fs sysname> command, which
25 can also be used to view the current value.  If a sysname list was set
26 using B<fs sysname>, only the first value in the list will be reported by
27 B<livesys>.
28
29 =head1 CAUTIONS
30
31 To see the full sysname list, use B<fs sysname> rather than this command.
32 B<livesys> is mostly useful for scripts that need to know the primary
33 sysname for the local system (to create directories that will later be
34 addressed using I<@sys>, for example).
35
36 B<livesys> first appeared in OpenAFS 1.2.2.  Scripts that need to support
37 older versions of AFS should parse the output of B<fs sysname> or use
38 B<sys>.
39
40 =head1 OUTPUT
41
42 The machine's system type appears as a text string, by itself, on a single
43 line.
44
45 =head1 EXAMPLES
46
47 The following example shows the output produced on a Linux system with a
48 2.6 kernel:
49
50    % livesys
51    i386_linux26
52
53 =head1 PRIVILEGE REQUIRED
54
55 None
56
57 =head1 SEE ALSO
58
59 L<fs_sysname(1)>,
60 L<sys(1)>
61
62 The I<OpenAFS Quick Start Guides> at L<http://docs.openafs.org/>.
63
64 The I<OpenAFS Administration Guide> at
65 L<http://docs.openafs.org/AdminGuide/>.
66
67 =head1 COPYRIGHT
68
69 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
70
71 Copyright 2005 Russ Allbery <rra@stanford.edu>
72
73 This documentation is covered by the IBM Public License Version 1.0.  It
74 was written by Russ Allbery based on the B<sys> man page.