summary refs log tree commit diff
path: root/doc/chpst.8.html
diff options
context:
space:
mode:
authorGerrit Pape <pape@smarden.org>2004-04-27 17:32:47 +0000
committerGerrit Pape <pape@smarden.org>2004-04-27 17:32:47 +0000
commit42491a14ee8610424e719499b385f3044efe00c6 (patch)
tree5d8f225eec63aad6bf723caf363175375dc3e2f8 /doc/chpst.8.html
parenta895d97d5a31f4f864acc271e28dacc63f02a18e (diff)
downloadrunit-42491a14ee8610424e719499b385f3044efe00c6.tar.gz
runit-42491a14ee8610424e719499b385f3044efe00c6.tar.xz
runit-42491a14ee8610424e719499b385f3044efe00c6.zip
chpst: support -/ chroot.
Diffstat (limited to 'doc/chpst.8.html')
-rw-r--r--doc/chpst.8.html94
1 files changed, 49 insertions, 45 deletions
diff --git a/doc/chpst.8.html b/doc/chpst.8.html
index acba8b0..8f873c2 100644
--- a/doc/chpst.8.html
+++ b/doc/chpst.8.html
@@ -12,21 +12,21 @@
 chpst - runs a program with a changed process state 
 <h2><a name='sect1'>Synopsis</a></h2>
 <b>chpst</b> [-vP012]
-[-u <i>user</i>] [-U <i>user</i>] [-e <i>dir</i>] [-l|-L <i>lock</i>] [-m <i>bytes</i>] [-o <i>n</i>] [-p <i>n</i>] [-f <i>bytes</i>] [-c
-<i>bytes</i>] <i>prog</i> 
+[-u <i>user</i>] [-U <i>user</i>] [-e <i>dir</i>] [-/ <i>root</i>] [-l|-L <i>lock</i>] [-m <i>bytes</i>] [-o <i>n</i>] [-p <i>n</i>] [-f <i>bytes</i>]
+[-c <i>bytes</i>] <i>prog</i> 
 <h2><a name='sect2'>Description</a></h2>
 <i>prog</i> consists of one or more arguments. <p>
-<b>chpst</b> changes
-the process state according to the given options, and runs <i>prog</i>. 
+<b>chpst</b>
+changes the process state according to the given options, and runs <i>prog</i>.
+
 <h2><a name='sect3'>Options</a></h2>
 
 <dl>
 
-<dt><b>-u
-<i>user[:group]</b> </i></dt>
-<dd>setuidgid. Set uid and gid to the <i>user</i>&rsquo;s uid and gid. If <i>user</i>
-is followed by a colon and a <i>group</i>, set the gid to <i>group</i>&rsquo;s gid instead of
-<i>user</i>&rsquo;s gid. All supplementary groups are removed. </dd>
+<dt><b>-u <i>user[:group]</b> </i></dt>
+<dd>setuidgid. Set uid and gid to the <i>user</i>&rsquo;s uid and gid.
+If <i>user</i> is followed by a colon and a <i>group</i>, set the gid to <i>group</i>&rsquo;s gid instead
+of <i>user</i>&rsquo;s gid. All supplementary groups are removed. </dd>
 
 <dt><b>-U <i>user[:group]</b> </i></dt>
 <dd>envuidgid.
@@ -43,69 +43,73 @@ adds the environment variable <i>k</i> with the value <i>v</i>. The name <i>k</i
 to newlines. If the file <i>k</i> is empty (0 bytes long), <b>chpst</b> removes the environment
 variable <i>k</i> if it exists, without adding a new variable. </dd>
 
+<dt><b>-/ <i>root</b> </i></dt>
+<dd>chroot. Change
+the root directory to <i>root</i> before starting <i>prog</i>. </dd>
+
 <dt><b>-l <i>lock</b> </i></dt>
-<dd>lock. Open
-the file <i>lock</i> for writing, and obtain an exclusive lock on it. <i>lock</i> will
-be created if it does not exist. If <i>lock</i> is locked by another process, wait
-until a new lock can be obtained. </dd>
+<dd>lock. Open the file
+<i>lock</i> for writing, and obtain an exclusive lock on it. <i>lock</i> will be created
+if it does not exist. If <i>lock</i> is locked by another process, wait until a
+new lock can be obtained. </dd>
 
 <dt><b>-L <i>lock</b> </i></dt>
-<dd>The same as -l, but fail immediately
-if <i>lock</i> is locked by another process. </dd>
+<dd>The same as -l, but fail immediately if
+<i>lock</i> is locked by another process. </dd>
 
 <dt><b>-m <i>bytes</b> </i></dt>
-<dd>limit memory. Limit the data
-segment, stack segment, locked physical pages, and total of all segment
-per process to <i>bytes</i> bytes each. </dd>
+<dd>limit memory. Limit the data segment,
+stack segment, locked physical pages, and total of all segment per process
+to <i>bytes</i> bytes each. </dd>
 
 <dt><b>-o <i>n</b> </i></dt>
-<dd>limit open files. Limit the number of
-open file descriptors per process to <i>n</i>. </dd>
+<dd>limit open files. Limit the number of open file
+descriptors per process to <i>n</i>. </dd>
 
 <dt><b>-p <i>n</b> </i></dt>
-<dd>limit processes. Limit the number
-of processes per uid to <i>n</i>. </dd>
+<dd>limit processes. Limit the number of processes
+per uid to <i>n</i>. </dd>
 
 <dt><b>-f <i>bytes</b> </i></dt>
-<dd>limit output size. Limit the output file
-size to <i>bytes</i> bytes. </dd>
+<dd>limit output size. Limit the output file size to <i>bytes</i>
+bytes. </dd>
 
 <dt><b>-c <i>bytes</b> </i></dt>
-<dd>limit core size. Limit the core file size to
-<i>bytes</i> bytes. </dd>
+<dd>limit core size. Limit the core file size to <i>bytes</i> bytes. </dd>
 
-<dt><b>-v</b> </dt>
-<dd>verbose. Print verbose messages to standard error. This includes
-warnings about limits unsupported by the system. </dd>
+<dt><b>-v</b>
+</dt>
+<dd>verbose. Print verbose messages to standard error. This includes warnings
+about limits unsupported by the system. </dd>
 
 <dt><b>-P</b> </dt>
-<dd>pgrphack. Run <i>prog</i> in
-a new process group. </dd>
+<dd>pgrphack. Run <i>prog</i> in a new process
+group. </dd>
 
 <dt><b>-0</b> </dt>
-<dd>Close standard input before running <i>prog</i>. </dd>
+<dd>Close standard input before starting <i>prog</i>. </dd>
 
 <dt><b>-1</b> </dt>
-<dd>Close
-standard output before running <i>prog</i>. </dd>
+<dd>Close standard output
+before starting <i>prog</i>. </dd>
 
 <dt><b>-2</b> </dt>
-<dd>Close standard error before running
-<i>prog</i>. </dd>
+<dd>Close standard error before starting <i>prog</i>. </dd>
 </dl>
 
 <h2><a name='sect4'>Exit Codes</a></h2>
-<b>chpst</b> exits 100 when called with wrong options. It prints
-an error message and exits 111 if it has trouble changing the process state.
-Otherwise its exit code is the same as that of <i>prog</i>. 
+<b>chpst</b>
+exits 100 when called with wrong options. It prints an error message and
+exits 111 if it has trouble changing the process state. Otherwise its exit
+code is the same as that of <i>prog</i>. 
 <h2><a name='sect5'>Emulation</a></h2>
-If <b>chpst</b> is
-called as <i><b>envdir</b>(8)</i>, <i><b>envuidgid</b>(8)</i>, <i><b>pgrphack</b>(8)</i>, <i><b>setlock</b>(8)</i>, <i><b>setuidgid</b>(8)</i>,
-or <i><b>softlimit</b>(8)</i>, it emulates the functionality of these programs from the
-daemontools package respectively. 
+If <b>chpst</b> is called as <i><b>envdir</b>(8)</i>,
+<i><b>envuidgid</b>(8)</i>, <i><b>pgrphack</b>(8)</i>, <i><b>setlock</b>(8)</i>, <i><b>setuidgid</b>(8)</i>, or <i><b>softlimit</b>(8)</i>, it
+emulates the functionality of these programs from the daemontools package
+respectively. 
 <h2><a name='sect6'>See Also</a></h2>
-<i>runsv(8)</i>, <i>runsvctrl(8)</i>, <i>runsvstat(8)</i>,
-<i>runsvdir(8)</i>, <i>setsid(2)</i> <p>
+<i>runsv(8)</i>, <i>runsvctrl(8)</i>, <i>runsvstat(8)</i>, <i>runsvdir(8)</i>,
+<i>setsid(2)</i> <p>
  <i>http://smarden.org/runit/</i><br>
   <i>http://cr.yp.to/daemontools.html</i><br>