summaryrefslogtreecommitdiffstats
path: root/man/prokit-shell.8in
diff options
context:
space:
mode:
Diffstat (limited to 'man/prokit-shell.8in')
-rw-r--r--man/prokit-shell.8in39
1 files changed, 39 insertions, 0 deletions
diff --git a/man/prokit-shell.8in b/man/prokit-shell.8in
new file mode 100644
index 0000000..f42b15a
--- /dev/null
+++ b/man/prokit-shell.8in
@@ -0,0 +1,39 @@
+.TH prokit-shell 8 \
+"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 [\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
+.P
+The ProteanOS Development Kit is free software: you can redistribute
+it and/or modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+.P
+The ProteanOS Development Kit is distributed in the hope that it
+will be useful, but WITHOUT ANY WARRANTY; without even the implied
+warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU General Public License for more details.
+.P
+You should have received a copy of the GNU General Public License
+along with the ProteanOS Development Kit. If not, see
+<http://www.gnu.org/licenses/>.