summaryrefslogtreecommitdiffstats
path: root/dev/prokit
diff options
context:
space:
mode:
authorP. J. McDermott <pehjota>2014-09-02 12:14:53 (EDT)
committer P. J. McDermott <pj@pehjota.net>2014-09-02 12:14:53 (EDT)
commit924343aa8d238f22f04c52e91d1ec2e295efaf09 (patch)
tree5e981136122d4ea59b92ff17c6d36ac54101fa77 /dev/prokit
parent680e280d200f71d885ac111376f7019a43f0a265 (diff)
dev/prokit/*: New manual pages
Diffstat (limited to 'dev/prokit')
-rw-r--r--dev/prokit/prokit-build.8.mdwn71
-rw-r--r--dev/prokit/prokit-help.1.mdwn71
-rw-r--r--dev/prokit/prokit-opkg.8.mdwn73
-rw-r--r--dev/prokit/prokit-shell.8.mdwn102
-rw-r--r--dev/prokit/prokit-version.1.mdwn65
-rw-r--r--dev/prokit/prokit.1.mdwn133
6 files changed, 515 insertions, 0 deletions
diff --git a/dev/prokit/prokit-build.8.mdwn b/dev/prokit/prokit-build.8.mdwn
new file mode 100644
index 0000000..fefa5fc
--- /dev/null
+++ b/dev/prokit/prokit-build.8.mdwn
@@ -0,0 +1,71 @@
+[[!meta title="prokit-build"]]
+
+<a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
+<a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#COPYRIGHT">COPYRIGHT</a><br>
+
+<hr>
+
+
+<h2>NAME
+<a name="NAME"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">prokit-build
+&minus; Build a package</p>
+
+<h2>SYNOPSIS
+<a name="SYNOPSIS"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+build</b> <i>root-dir</i> [<i>option</i> ...]
+<i>pkg-dir</i></p>
+
+<h2>DESCRIPTION
+<a name="DESCRIPTION"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><i><b>prokit
+build</b></i> runs <b>opkbuild</b> to build a package in an
+isolated file system environment, temporarily installing any
+missing build dependencies.</p>
+
+<p style="margin-left:11%; margin-top: 1em"><i>option</i>s
+are <b>opkbuild</b> options. Run <i>prokit build -h .</i>
+for more information.</p>
+
+<p style="margin-left:11%; margin-top: 1em"><i>pkg-dir</i>
+is a source package directory.</p>
+
+<h2>COPYRIGHT
+<a name="COPYRIGHT"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">Copyright (C)
+2014 Patrick &quot;P. J.&quot; McDermott</p>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">You should have
+received a copy of the GNU General Public License along with
+the ProteanOS Development Kit. If not, see
+&lt;http://www.gnu.org/licenses/&gt;.</p>
+
diff --git a/dev/prokit/prokit-help.1.mdwn b/dev/prokit/prokit-help.1.mdwn
new file mode 100644
index 0000000..733a358
--- /dev/null
+++ b/dev/prokit/prokit-help.1.mdwn
@@ -0,0 +1,71 @@
+[[!meta title="prokit-help"]]
+
+<a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
+<a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#COPYRIGHT">COPYRIGHT</a><br>
+
+<hr>
+
+
+<h2>NAME
+<a name="NAME"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">prokit-help
+&minus; Print help information</p>
+
+<h2>SYNOPSIS
+<a name="SYNOPSIS"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+help</b> [<i>command</i>]</p>
+
+<h2>DESCRIPTION
+<a name="DESCRIPTION"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">With no
+<i>command</i> given, <b>prokit help</b> prints a synopsis
+and option list for the <b>prokit</b> command and a list of
+prokit commands with descriptions.</p>
+
+<p style="margin-left:11%; margin-top: 1em">With a
+<i>command</i> given, <b>prokit help</b> prints a synopsis
+for that <i>command</i>.</p>
+
+<p style="margin-left:11%; margin-top: 1em">Note that
+<b>prokit -h</b> [<i>command</i>] is equivalent to <b>prokit
+help</b> [<i>command</i>].</p>
+
+<h2>COPYRIGHT
+<a name="COPYRIGHT"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">Copyright (C)
+2014 Patrick &quot;P. J.&quot; McDermott</p>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">You should have
+received a copy of the GNU General Public License along with
+the ProteanOS Development Kit. If not, see
+&lt;http://www.gnu.org/licenses/&gt;.</p>
+
diff --git a/dev/prokit/prokit-opkg.8.mdwn b/dev/prokit/prokit-opkg.8.mdwn
new file mode 100644
index 0000000..7fb3a30
--- /dev/null
+++ b/dev/prokit/prokit-opkg.8.mdwn
@@ -0,0 +1,73 @@
+[[!meta title="prokit-opkg"]]
+
+<a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
+<a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#COPYRIGHT">COPYRIGHT</a><br>
+
+<hr>
+
+
+<h2>NAME
+<a name="NAME"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">prokit-opkg
+&minus; Manage packages with opkg</p>
+
+<h2>SYNOPSIS
+<a name="SYNOPSIS"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+opkg</b> <i>root-dir</i> [<i>option</i> ...]
+<i>sub-command</i> [<i>argument</i> ...]</p>
+
+<h2>DESCRIPTION
+<a name="DESCRIPTION"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+opkg</b> runs <b>opkg</b> in an isolated file system
+environment.</p>
+
+<p style="margin-left:11%; margin-top: 1em"><i>option</i>s
+are <b>opkg</b> options and <i>sub-command</i> is an
+<b>opkg</b> sub-command. See the usage information for
+<b>opkg</b> for more information.</p>
+
+<p style="margin-left:11%; margin-top: 1em">If
+<i>sub-command</i> is <i>install</i>, any package files
+listed in <i>argument</i>s are temporarily copied into the
+isolated system for installation.</p>
+
+<h2>COPYRIGHT
+<a name="COPYRIGHT"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">Copyright (C)
+2014 Patrick &quot;P. J.&quot; McDermott</p>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">You should have
+received a copy of the GNU General Public License along with
+the ProteanOS Development Kit. If not, see
+&lt;http://www.gnu.org/licenses/&gt;.</p>
+
diff --git a/dev/prokit/prokit-shell.8.mdwn b/dev/prokit/prokit-shell.8.mdwn
new file mode 100644
index 0000000..f454a0f
--- /dev/null
+++ b/dev/prokit/prokit-shell.8.mdwn
@@ -0,0 +1,102 @@
+[[!meta title="prokit-shell"]]
+
+<a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
+<a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#EXAMPLES">EXAMPLES</a><br>
+<a href="#COPYRIGHT">COPYRIGHT</a><br>
+
+<hr>
+
+
+<h2>NAME
+<a name="NAME"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">prokit-shell
+&minus; Run a shell in an isolated environment</p>
+
+<h2>SYNOPSIS
+<a name="SYNOPSIS"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+shell</b> <i>root-dir</i> [<i>command</i> [<i>argument</i>
+...]]</p>
+
+<h2>DESCRIPTION
+<a name="DESCRIPTION"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+shell</b> starts a shell in an isolated file system
+environment (using <b>chroot</b>(8)) with basic file systems
+mounted.</p>
+
+<p style="margin-left:11%; margin-top: 1em">If a
+<i>command</i> is given (with optional <i>argument</i>s), it
+is executed in a non-interactive shell.</p>
+
+<h2>EXAMPLES
+<a name="EXAMPLES"></a>
+</h2>
+
+
+<table width="100%" border="0" rules="none" frame="void"
+ cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="1%">
+
+
+<p style="margin-top: 1em">&bull;</p></td>
+<td width="10%"></td>
+<td width="78%">
+
+
+<p style="margin-top: 1em"># prokit shell $root echo Hello
+world</p> </td></tr>
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="1%">
+
+
+<p>&bull;</p></td>
+<td width="10%"></td>
+<td width="78%">
+
+
+<p># prokit shell $root &rsquo;opkg install
+build-essential-$(cat /etc/proteanos_arch)&rsquo;</p></td></tr>
+</table>
+
+<h2>COPYRIGHT
+<a name="COPYRIGHT"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">Copyright (C)
+2014 Patrick &quot;P. J.&quot; McDermott</p>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">You should have
+received a copy of the GNU General Public License along with
+the ProteanOS Development Kit. If not, see
+&lt;http://www.gnu.org/licenses/&gt;.</p>
+
diff --git a/dev/prokit/prokit-version.1.mdwn b/dev/prokit/prokit-version.1.mdwn
new file mode 100644
index 0000000..aa6cb4e
--- /dev/null
+++ b/dev/prokit/prokit-version.1.mdwn
@@ -0,0 +1,65 @@
+[[!meta title="prokit-version"]]
+
+<a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
+<a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#COPYRIGHT">COPYRIGHT</a><br>
+
+<hr>
+
+
+<h2>NAME
+<a name="NAME"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">prokit-version
+&minus; Print version information</p>
+
+<h2>SYNOPSIS
+<a name="SYNOPSIS"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+version</b></p>
+
+<h2>DESCRIPTION
+<a name="DESCRIPTION"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit
+version</b> prints version, copyright, and license
+information for prokit.</p>
+
+<p style="margin-left:11%; margin-top: 1em">Note that
+<b>prokit -V</b> is equivalent to <b>prokit version</b>.</p>
+
+<h2>COPYRIGHT
+<a name="COPYRIGHT"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">Copyright (C)
+2014 Patrick &quot;P. J.&quot; McDermott</p>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">You should have
+received a copy of the GNU General Public License along with
+the ProteanOS Development Kit. If not, see
+&lt;http://www.gnu.org/licenses/&gt;.</p>
+
diff --git a/dev/prokit/prokit.1.mdwn b/dev/prokit/prokit.1.mdwn
new file mode 100644
index 0000000..4db796b
--- /dev/null
+++ b/dev/prokit/prokit.1.mdwn
@@ -0,0 +1,133 @@
+[[!meta title="prokit"]]
+
+<a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
+<a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#OPTIONS">OPTIONS</a><br>
+<a href="#PROKIT COMMANDS">PROKIT COMMANDS</a><br>
+<a href="#COPYRIGHT">COPYRIGHT</a><br>
+
+<hr>
+
+
+<h2>NAME
+<a name="NAME"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">prokit &minus;
+ProteanOS Development Kit</p>
+
+<h2>SYNOPSIS
+<a name="SYNOPSIS"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit</b>
+[<i>option</i> ...] <i>command</i> [<i>arg</i> ...]</p>
+
+<h2>DESCRIPTION
+<a name="DESCRIPTION"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit</b>
+can install a ProteanOS system and run a ProteanOS shell
+within an isolated file system environment using the chroot
+utility. It is similar in function to the debootstrap
+program of Debian and derivatives.</p>
+
+<h2>OPTIONS
+<a name="OPTIONS"></a>
+</h2>
+
+
+<table width="100%" border="0" rules="none" frame="void"
+ cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="3%">
+
+
+<p style="margin-top: 1em"><b>&minus;h</b></p></td>
+<td width="8%"></td>
+<td width="38%">
+
+
+<p style="margin-top: 1em">Print help information</p></td>
+<td width="40%">
+</td></tr>
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="3%">
+
+
+<p><b>&minus;V</b></p></td>
+<td width="8%"></td>
+<td width="38%">
+
+
+<p>Print version information</p></td>
+<td width="40%">
+</td></tr>
+</table>
+
+<h2>PROKIT COMMANDS
+<a name="PROKIT COMMANDS"></a>
+</h2>
+
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>prokit-help</b>(1)</p>
+
+<p style="margin-left:22%;">Print help information</p>
+
+<p style="margin-left:11%;"><b>prokit-version</b>(1)</p>
+
+<p style="margin-left:22%;">Print version information</p>
+
+<p style="margin-left:11%;"><b>prokit-install</b>(8)</p>
+
+<p style="margin-left:22%;">Install a system into a
+directory</p>
+
+<p style="margin-left:11%;"><b>prokit-shell</b>(8)</p>
+
+<p style="margin-left:22%;">Run a shell in an isolated
+environment</p>
+
+<p style="margin-left:11%;"><b>prokit-opkg</b>(8)</p>
+
+<p style="margin-left:22%;">Manage packages with opkg</p>
+
+<p style="margin-left:11%;"><b>prokit-build</b>(8)</p>
+
+<p style="margin-left:22%;">Build a package</p>
+
+<h2>COPYRIGHT
+<a name="COPYRIGHT"></a>
+</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em">Copyright (C)
+2014 Patrick &quot;P. J.&quot; McDermott</p>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">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>
+
+<p style="margin-left:11%; margin-top: 1em">You should have
+received a copy of the GNU General Public License along with
+the ProteanOS Development Kit. If not, see
+&lt;http://www.gnu.org/licenses/&gt;.</p>
+