doc/man-pages/pod8/vsys.pod

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