vmcp/vmcp.8

   1 .TH vmcp "8" "Apr 2006" "s390-tools"
   2 .LO 8
   3 .SH NAME
   4 vmcp \- send commands to the z/VM control program
   5 .SH SYNOPSIS
   6 .BI vmcp
   7 [\fI-k\fR] [\fI-b <size>\fR] command
   8
   9 .BI vmcp
  10 [\fI-h|-v\fR]
  11
  12
  13 .SH DESCRIPTION
  14 vmcp allows Linux users to send commands to the control program of z/VM.
  15 The normal usage is to invoke vmcp with the command you want to
  16 execute. If the
  17 .BI -k
  18 option is not specified, the whole command line is automatically translated
  19 into uppercase. The response of z/VM is written to the standard output.
  20
  21 .BI vmcp
  22 needs a kernel feature represented by the device node /dev/vmcp.
  23 The kernel module defines a buffer size, which limits the length of the
  24 response. Every output larger than the compiled buffer size is
  25 silently dropped.
  26 Depending on you shell, please remember to escape special characters
  27 like * using \\* instead.
  28 .SH RETURN CODES
  29 vmcp writes the response to stdout and any error message to stderr.
  30 Depending on the success one of the following return codes is returned:
  31 .TP
  32 .BR "0"
  33 No problem in vmcp or CP.
  34
  35 .TP
  36 .BR "1"
  37 CP returned a non-zero response code.
  38
  39 .TP
  40 .BR "2"
  41 The specified buffer was not large enough to hold CP's response. The command
  42 was executed, nevertheless, and the response was truncated. You can use the
  43 --buffer option to increase the response buffer.
  44
  45 .TP
  46 .BR "3"
  47 Linux reported an error to vmcp. See the error message for details.
  48
  49 .TP
  50 .BR "4"
  51 The options passed to vmcp were erroneous. See the error messages for details.
  52
  53
  54
  55
  56 .SH EXAMPLES
  57 To get your user id
  58 .IP
  59 .nf
  60 vmcp query userid
  61 .fi
  62 .P
  63
  64 To attach the device 1234 to your guest
  65 .IP
  66 .nf
  67 vmcp attach 1234 \\*
  68 .fi
  69 .P
  70
  71 If add the following line to /etc/sudoers
  72
  73 .BI "ALL ALL=NOPASSWD: /sbin/vmcp indicate"
  74
  75 every user on the system can run the indicate command
  76 .IP
  77 .nf
  78 sudo vmcp indicate
  79 .fi
  80 .P
  81
  82
  83 .SH CREDITS
  84 The basic idea of vmcp is based on cpint of Neale Fergusson.
  85 .SH OPTIONS
  86 .TP
  87 .BR "\-h" " or " "--help"
  88 Print usage information, then exit
  89
  90 .TP
  91 .BR "\-v" " or " "--version"
  92 Print version information, then exit
  93
  94 .TP
  95 .BR "\-k" " or " "--keepcase"
  96 Using this option, vmcp does not convert the command to uppercase.
  97 (The default is to translate the command string to uppercase)
  98
  99 .TP
 100 .BR "\-b <size>" " or " "--buffer=<size>"
 101 Specify a buffer size for the response. The buffer size can be specified
 102 from 4096 bytes (4k) to 1048576 Bytes (1M). The default size is 2 pages
 103 (8192 Bytes). You can also use k/K/m/M for kilobytes and Megabytes
 104
 105 .SH "SEE ALSO"
 106 sudo(8)