Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_messages.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fs_messages - Sets whether the Cache Manager writes log messages
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fs messages> S<<< [B<-show> (user|console|all|none)] >>> [B<-help>]
11
12B<fs me> S<<< [B<-s> (user|console|all|none)] >>> [B<-h>]
13
14=for html
15</div>
16
17=head1 DESCRIPTION
18
19The B<fs messages> command controls whether the Cache Manager displays
20status and warning messages on user screens, the client machine console,
21on both, or on neither.
22
23There are two types of Cache Manager messages:
24
25=over 4
26
27=item *
28
29User messages provide user-level status and warning information, and the
30Cache Manager directs them to user screens.
31
32=item *
33
34Console messages provide system-level status and warning information, and
35the Cache Manager directs them to the client machine's designated console.
36
37=back
38
39Disabling messaging completely is not recommended, because the messages
40provide useful status and warning information.
41
42=head1 OPTIONS
43
44=over 4
45
46=item B<-show> (user|console|all|none)
47
48Specifies the types of messages to display. Choose one of the following
49values:
50
51=over 4
52
53=item user
54
55Send user messages to user screens.
56
57=item console
58
59Send console messages to the console.
60
61=item all
62
63Send user messages to user screens and console messages to the console
64(the default if the B<-show> argument is omitted).
65
66=item none
67
68Do not send any messages to user screens or the console.
69
70=back
71
72=item B<-help>
73
74Prints the online help for this command. All other valid options are
75ignored.
76
77=back
78
79=head1 EXAMPLES
80
81The following command instructs the Cache Manager to display both types of
82messages:
83
84 % fs messages -show all
85
86=head1 PRIVILEGE REQUIRED
87
88The issuer must be logged in as the local superuser root.
89
90=head1 SEE ALSO
91
92L<afsd(8)>
93
94=head1 COPYRIGHT
95
96IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
97
98This documentation is covered by the IBM Public License Version 1.0. It was
99converted from HTML to POD by software written by Chas Williams and Russ
100Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.