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