summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorP. J. McDermott <pj@pehjota.net>2014-09-01 17:33:41 (EDT)
committer P. J. McDermott <pj@pehjota.net>2014-09-01 17:33:41 (EDT)
commit1a8f977120dbc15b9a0dc29c4969cebde98ea3d0 (patch)
tree96fc1b0e9c6955253b92b58f46e46f7f7c3db8ba /man
parent9d1b9f98db96f1fc20e9acf106efd9559fdded6f (diff)
prokit-shell(1): Document command arguments
Diffstat (limited to 'man')
-rw-r--r--man/prokit-shell.1in14
1 files changed, 12 insertions, 2 deletions
diff --git a/man/prokit-shell.1in b/man/prokit-shell.1in
index 8cac92a..956e88b 100644
--- a/man/prokit-shell.1in
+++ b/man/prokit-shell.1in
@@ -1,15 +1,25 @@
.TH prokit-shell 1 \
-"2014-08-25" "@PACKAGE_NAME@ @PACKAGE_VERSION@" "@MANUAL@"
+"2014-09-01" "@PACKAGE_NAME@ @PACKAGE_VERSION@" "@MANUAL@"
.SH NAME
prokit-shell \- Run a shell in an isolated environment
.SH SYNOPSIS
-\fBprokit shell\fP \fIroot-dir\fP
+\fBprokit shell\fP \fIroot-dir\fP [\fIcommand\fP [\fIargument\fP ...]]
.SH DESCRIPTION
\fBprokit shell\fP starts a shell in an isolated file system environment (using
\fBchroot\fP(8)) with basic file systems mounted.
+.P
+If a \fIcommand\fP is given (with optional \fIargument\fPs), it is executed in a
+non-interactive shell.
+
+.SH EXAMPLES
+
+.IP \[bu]
+# prokit shell $root echo Hello world
+.IP \[bu]
+# prokit shell $root 'opkg install build-essential-$(cat /etc/proteanos_arch)'
.SH COPYRIGHT
Copyright (C) 2014 Patrick "P. J." McDermott