Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / vsys.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3vsys - Make AFS system calls from the command line
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<vsys> <I<call number>> <I<parms>>+
11
12=for html
13</div>
14
15=head1 DESCRIPTION
16
17B<vsys> is a development tool to make AFS system calls from the command
18line. <I<call number>> is the AFS system call to be invoked. <I<parms>>+
19are the values to pass to the system call. Knowledge of the AFS system
20call layer is required to know valid call numbers and parameters.
21
22=head1 CAUTIONS
23
24B<vsys> is intended for debugging AFS at a low level and is therefore
25intended for AFS developers. System Administrators and AFS users should
26use the higher-level interfaces provided by L<fs(1)>, L<aklog(1)>,
27L<klog(1)>, and L<pagsh(1)> instead.
28
29B<vsys> provides a way to pass arbitrary data into the AFS system call
30mechanism. Caution should be taken when using or providing this binary on
31a system, as incorrect use as a privileged user could cause a system to
32panic, hang, or perform an unsafe operation.
33
34=head1 PRIVILEGE REQUIRED
35
36The issuer must be logged in as the local superuser root.
37
38=head1 SEE ALSO
39
40L<afsd(8)>,
41L<aklog(1)>,
42L<fs(1)>,
43L<klog(1)>,
44L<pagsh(1)>
45
46=head1 COPYRIGHT
47
48Copyright 2009 Steven Jenkins <steven@endpoint.com>
49
50This documentation is covered by the BSD License as written in the
51doc/LICENSE file. This man page was written by Steven Jenkins for OpenAFS.