[hcoop/debian/openafs.git] / doc / man-pages / pod8 / dafileserver.pod.in

=head1 NAME

dafileserver - Initializes the File Server component of the dafs process

=head1 SYNOPSIS

=for html
<div class="synopsis">

=include fragments/dafileserver-synopsis.pod

=for html
</div>

=head1 DESCRIPTION

The B<dafileserver> command initializes the File Server component of the
C<dafs> process. In the conventional configuration, its binary file is
located in the F</usr/afs/bin> directory on a file server machine.

The B<dafileserver> command is not normally issued at the command shell
prompt, but rather placed into a database server machine's
F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
ever issued at the command shell prompt, the issuer must be logged onto a
file server machine as the local superuser C<root>.

=include fragments/fileserver-description.pod

=head1 CAUTIONS

=include fragments/fileserver-cautions.pod

=head1 OPTIONS

=include fragments/fileserver-options.pod

=item B<-fs-state-dont-save>

When present, fileserver state will not be saved during shutdown.  Default
is to save state.

=item B<-fs-state-dont-restore>

When present, fileserver state will not be restored during startup.
Default is to restore state on startup.

=item B<-fs-state-verify> (none | save | restore | both)

This argument controls the behavior of the state verification mechanism.
A value of C<none> turns off all verification.  A value of C<save> only
performs the verification steps prior to saving state to disk.  A value
of C<restore> only performs the verification steps after restoring state
from disk.  A value of C<both> performs all verifications steps both
prior to save and following a restore.

The default is C<both>.

=item B<-vlrudisable>

This option completely disables the VLRU mechanism, which means volumes will
never "soft detach". The use of this option is only intended for debugging use
or if you find a serious bug in the VLRU mechanism you wish to work around.

=item B<-vlruthresh <I<minutes>>

The number of minutes of inactivity before a volume is eligible for soft
detachment.  Default is 120 minutes.

=item B<-vlruinterval <I<seconds>>

The number of seconds between VLRU candidate queue scan.  The default is
120 seconds.

=item B<-vlrumax <I<positive integer>>

The maximum number of volumes which can be soft detached in a single pass
of the scanner.  Default is 8 volumes.

=item B<-unsafe-nosalvage>

This option causes the fileserver to bypass the normal safety check when
attaching volumes that checks the inUse field in the volume header. With
this option, volumes that were in use at the time of an unclean shutdown
will not be salvaged immediately the next time they are accessed, and thus
risk (possibly silent and/or irrevocable) corruption. Volumes will still
be salvaged when an internal inconsistency is detected or other cases
where a salvage would normally occur.

Due to the increased risk of data corruption, the use of this flag is
strongly discouraged. Only use it if you really know what you are doing.

=back

=head1 EXAMPLES

The following B<bos create> command creates a dafs process on
the file server machine C<fs2.example.com> that uses the large configuration
size, and allows volumes to exceed their quota by 10%. Type the command on
a single line:

   % bos create -server fs2.example.com -instance dafs -type dafs \
                -cmd "/usr/afs/bin/dafileserver -pctspare 10 -L" \
                /usr/afs/bin/davolserver \
                /usr/afs/bin/salvageserver \
                /usr/afs/bin/dasalvager

=head1 TROUBLESHOOTING

=include fragments/fileserver-troubleshooting.pod

=head1 PRIVILEGE REQUIRED

=include fragments/fileserver-privilege.pod

=head1 SEE ALSO

=include fragments/fileserver-also.pod
L<fileserver(8)>,

=head1 COPYRIGHT

=include fragments/fileserver-copyright.pod
Commit	Line	Data
805e021f CE	1	=head1 NAME
	2
	3	dafileserver - Initializes the File Server component of the dafs process
	4
	5	=head1 SYNOPSIS
	6
	7	=for html
	8	<div class="synopsis">
	9
	10	=include fragments/dafileserver-synopsis.pod
	11
	12	=for html
	13	</div>
	14
	15	=head1 DESCRIPTION
	16
	17	The B<dafileserver> command initializes the File Server component of the
	18	C<dafs> process. In the conventional configuration, its binary file is
	19	located in the F</usr/afs/bin> directory on a file server machine.
	20
	21	The B<dafileserver> command is not normally issued at the command shell
	22	prompt, but rather placed into a database server machine's
	23	F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
	24	ever issued at the command shell prompt, the issuer must be logged onto a
	25	file server machine as the local superuser C<root>.
	26
	27	=include fragments/fileserver-description.pod
	28
	29	=head1 CAUTIONS
	30
	31	=include fragments/fileserver-cautions.pod
	32
	33	=head1 OPTIONS
	34
	35	=include fragments/fileserver-options.pod
	36
	37	=item B<-fs-state-dont-save>
	38
	39	When present, fileserver state will not be saved during shutdown. Default
	40	is to save state.
	41
	42	=item B<-fs-state-dont-restore>
	43
	44	When present, fileserver state will not be restored during startup.
	45	Default is to restore state on startup.
	46
	47	=item B<-fs-state-verify> (none \| save \| restore \| both)
	48
	49	This argument controls the behavior of the state verification mechanism.
	50	A value of C<none> turns off all verification. A value of C<save> only
	51	performs the verification steps prior to saving state to disk. A value
	52	of C<restore> only performs the verification steps after restoring state
	53	from disk. A value of C<both> performs all verifications steps both
	54	prior to save and following a restore.
	55
	56	The default is C<both>.
	57
	58	=item B<-vlrudisable>
	59
	60	This option completely disables the VLRU mechanism, which means volumes will
	61	never "soft detach". The use of this option is only intended for debugging use
	62	or if you find a serious bug in the VLRU mechanism you wish to work around.
	63
	64	=item B<-vlruthresh <I<minutes>>
65
66	The number of minutes of inactivity before a volume is eligible for soft
67	detachment. Default is 120 minutes.
68
69	=item B<-vlruinterval <I<seconds>>
70
71	The number of seconds between VLRU candidate queue scan. The default is
72	120 seconds.
73
74	=item B<-vlrumax <I<positive integer>>
75
76	The maximum number of volumes which can be soft detached in a single pass
77	of the scanner. Default is 8 volumes.
78
79	=item B<-unsafe-nosalvage>
80
81	This option causes the fileserver to bypass the normal safety check when
82	attaching volumes that checks the inUse field in the volume header. With
83	this option, volumes that were in use at the time of an unclean shutdown
84	will not be salvaged immediately the next time they are accessed, and thus
85	risk (possibly silent and/or irrevocable) corruption. Volumes will still
86	be salvaged when an internal inconsistency is detected or other cases
87	where a salvage would normally occur.
88
89	Due to the increased risk of data corruption, the use of this flag is
90	strongly discouraged. Only use it if you really know what you are doing.
91
92	=back
93
94	=head1 EXAMPLES
95
96	The following B<bos create> command creates a dafs process on
97	the file server machine C<fs2.example.com> that uses the large configuration
98	size, and allows volumes to exceed their quota by 10%. Type the command on
99	a single line:
100
101	% bos create -server fs2.example.com -instance dafs -type dafs \
102	-cmd "/usr/afs/bin/dafileserver -pctspare 10 -L" \
103	/usr/afs/bin/davolserver \
104	/usr/afs/bin/salvageserver \
105	/usr/afs/bin/dasalvager
106
107	=head1 TROUBLESHOOTING
108
109	=include fragments/fileserver-troubleshooting.pod
110
111	=head1 PRIVILEGE REQUIRED
112
113	=include fragments/fileserver-privilege.pod
114
115	=head1 SEE ALSO
116
117	=include fragments/fileserver-also.pod
118	L<fileserver(8)>,
119
120	=head1 COPYRIGHT
121
122	=include fragments/fileserver-copyright.pod