diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 8 | ||||
| -rw-r--r-- | doc/layman.8.xml | 220 |
2 files changed, 114 insertions, 114 deletions
diff --git a/doc/Makefile b/doc/Makefile index 64b28af..0a4a6a1 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,5 +1,5 @@ # -# layman/doc/Makefile +# overlord/doc/Makefile # Simple Makefile to rebuild the documentation from the # docbook XML sources # @@ -12,10 +12,10 @@ # # ======================================================================== -MAN_PAGES = layman.8 -HTML_PAGES = layman.8.html +MAN_PAGES = overlord.8 +HTML_PAGES = overlord.8.html -TMPFILE=./layman.man +TMPFILE=./overlord.man all: man html diff --git a/doc/layman.8.xml b/doc/layman.8.xml index dda55e9..319aeca 100644 --- a/doc/layman.8.xml +++ b/doc/layman.8.xml @@ -4,8 +4,8 @@ <article> <articleinfo> - <title>layman</title> - + <title>overlord</title> + <authorgroup> <author> <firstname>Gunnar</firstname> @@ -32,112 +32,112 @@ <itemizedlist> <listitem> <para> - <link linkend="layman-synopsis">Synopsis</link> + <link linkend="overlord-synopsis">Synopsis</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-description">Description</link> + <link linkend="overlord-description">Description</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-actions">Action flags</link> + <link linkend="overlord-actions">Action flags</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-other-options">Other options</link> + <link linkend="overlord-other-options">Other options</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-configuration">Configuration</link> + <link linkend="overlord-configuration">Configuration</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-remote">Overlay lists</link> + <link linkend="overlord-remote">Overlay lists</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-local">Layman cache</link> + <link linkend="overlord-local">overlord cache</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-make-conf">Handling make.conf</link> + <link linkend="overlord-make-conf">Handling make.conf</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-update">Handle overlays</link> + <link linkend="overlord-update">Handle overlays</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-list">List overlays</link> + <link linkend="overlord-list">List overlays</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-search">Searching ebuilds in overlays</link> + <link linkend="overlord-search">Searching ebuilds in overlays</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-types">Overlay types</link> + <link linkend="overlord-types">Overlay types</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-global">Get your overlay published to the world</link> + <link linkend="overlord-global">Get your overlay published to the world</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-examples">Examples</link> + <link linkend="overlord-examples">Examples</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-files">Layman files</link> + <link linkend="overlord-files">Overlord files</link> </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend="layman-bugs">Reporting bugs</link> + <link linkend="overlord-bugs">Reporting bugs</link> </para> </listitem> </itemizedlist> @@ -148,7 +148,7 @@ <itemizedlist> <listitem> <para> - <ulink url="http://sourceforge.net/projects/layman/">Layman project page on SourceForge</ulink> + <ulink url="http://sourceforge.net/projects/layman/">overlord project page on SourceForge</ulink> </para> </listitem> <listitem> @@ -189,14 +189,14 @@ </itemizedlist> </section> - <section id="layman-reference"> + <section id="overlord-reference"> <title>Reference</title> - <refentry id="layman-manpage"> + <refentry id="overlord-manpage"> <refentryinfo> - <title>layman</title> + <title>overlord</title> <date>July 2010</date> - <productname>layman</productname> + <productname>overlord</productname> <productnumber>1.4.1</productnumber> <copyright> <year>2005-2009</year> @@ -211,19 +211,19 @@ </legalnotice> </refentryinfo> <refmeta> - <refentrytitle>layman</refentrytitle> + <refentrytitle>overlord</refentrytitle> <manvolnum>8</manvolnum> </refmeta> <refnamediv> - <refname>layman</refname> + <refname>overlord</refname> <refpurpose> manage your local repository of Gentoo overlays </refpurpose> </refnamediv> - <refsynopsisdiv id="layman-synopsis"> + <refsynopsisdiv id="overlord-synopsis"> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-a</arg> <arg>--add</arg> @@ -235,7 +235,7 @@ </cmdsynopsis> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-d</arg> <arg>--delete</arg> @@ -247,7 +247,7 @@ </cmdsynopsis> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-s</arg> <arg>--sync</arg> @@ -259,7 +259,7 @@ </cmdsynopsis> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-i</arg> <arg>--info</arg> @@ -271,7 +271,7 @@ </cmdsynopsis> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-S</arg> <arg>--sync-all</arg> @@ -279,7 +279,7 @@ </cmdsynopsis> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-L</arg> <arg>--list</arg> @@ -287,7 +287,7 @@ </cmdsynopsis> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-l</arg> <arg>--list-local</arg> @@ -295,7 +295,7 @@ </cmdsynopsis> <cmdsynopsis> - <command>layman</command> + <command>overlord</command> <group choice="plain"> <arg>-f</arg> <arg>--fetch</arg> @@ -304,45 +304,45 @@ </refsynopsisdiv> - <refsection id="layman-description"> + <refsection id="overlord-description"> <title>Description</title> - <para><command>layman</command> is a script that allows you to + <para><command>overlord</command> is a script that allows you to add, remove and update Gentoo overlays from a variety of sources.</para> <refsection> <title>WARNING</title> - <para><command>layman</command> makes it easy to retrieve and + <para><command>overlord</command> makes it easy to retrieve and update overlays for Gentoo. In addition it makes it TRIVIAL - to break your system. + to break your system. </para> <para>The main portage tree provides you with high quality ebuilds that are all maintained by Gentoo developers. This will not be the case for most of the overlays you can get by using - <command>layman</command>. Thus you are removing the + <command>overlord</command>. Thus you are removing the security shield that the standard tree provides for you. You should keep that in mind when installing ebuilds from an overlay. </para> <para>To ensure the security of your system you MUST read the - source of the ebuild you are about to install. + source of the ebuild you are about to install. </para> </refsection> </refsection> - <refsection id="layman-options"> + <refsection id="overlord-options"> <title>Options</title> - <refsection id="layman-actions"> + <refsection id="overlord-actions"> <title>Actions</title> - <para>List of possible <command>layman</command> actions.</para> + <para>List of possible <command>overlord</command> actions.</para> <variablelist> <varlistentry> @@ -420,11 +420,11 @@ </variablelist> </refsection> - <refsection id="layman-other-options"> + <refsection id="overlord-other-options"> <title>Other options</title> - <para>List of other available <command>layman</command> options.</para> + <para>List of other available <command>overlord</command> options.</para> <variablelist> @@ -446,7 +446,7 @@ of URLs you specified in your config file. You may also specify local file URLs by prepending the path with <userinput>file://</userinput>. This option - will only append the URL for this specific layman run - + will only append the URL for this specific overlord run - edit your config file to add a URL permanently. So this is useful for testing purposes. </para> @@ -457,9 +457,9 @@ <term><option>-n</option></term> <term><option>--nofetch</option></term> <listitem> - <para>Prevents <command>layman</command> from + <para>Prevents <command>overlord</command> from automatically fetching the remote lists of overlays. The - default behavior for <command>layman</command> is to + default behavior for <command>overlord</command> is to update all remote lists if you run the sync, list or fetch operation.</para> </listitem> @@ -469,9 +469,9 @@ <term><option>-k</option></term> <term><option>--nocheck</option></term> <listitem> - <para>Prevents <command>layman</command> from checking + <para>Prevents <command>overlord</command> from checking the remote lists of overlays for complete overlay - definitions. The default behavior for layman is to + definitions. The default behavior for overlord is to reject overlays that do not provide a description or a contact attribute.</para> </listitem> @@ -481,7 +481,7 @@ <term><option>-q</option></term> <term><option>--quiet</option></term> <listitem> - <para>Makes <command>layman</command> completely quiet. + <para>Makes <command>overlord</command> completely quiet. In quiet mode child processes will be run with stdin closed to avoid running into infinite and blindly interactive sessions. Thus a child process may abort once it runs into an @@ -496,7 +496,7 @@ <term><option>-v</option></term> <term><option>--verbose</option></term> <listitem> - <para>Makes <command>layman</command> more verbose and + <para>Makes <command>overlord</command> more verbose and you will receive a description of the overlays you can download.</para> </listitem> @@ -506,7 +506,7 @@ <term><option>-N</option></term> <term><option>--nocolor</option></term> <listitem> - <para>Remove color codes from the <command>layman</command> + <para>Remove color codes from the <command>overlord</command> output.</para> </listitem> </varlistentry> @@ -515,7 +515,7 @@ <term><option>-Q</option><replaceable>LEVEL</replaceable></term> <term><option>--quietness</option><replaceable>LEVEL</replaceable></term> <listitem> - <para>Makes <command>layman</command> less verbose. + <para>Makes <command>overlord</command> less verbose. Choose a value between 0 and 4 with 0 being completely quiet. Once you set this below 3, the same warning as given for --quiet applies.</para> @@ -542,13 +542,13 @@ </refsection> - <refsection id="layman-configuration"> + <refsection id="overlord-configuration"> <title>Configuration</title> - <para><command>layman</command> reads configuration parameters + <para><command>overlord</command> reads configuration parameters from the file - <filename>/etc/layman/layman.cfg</filename> by + <filename>/etc/overlord/overlord.cfg</filename> by default. This file provides seven possible settings.</para> <variablelist> @@ -557,16 +557,16 @@ <term><option>storage</option></term> <listitem> <para>Directory that will be used to store the overlays - and all additional data <command>layman</command> + and all additional data <command>overlord</command> needs. The default is - <filename>/var/lib/layman</filename>. layman + <filename>/var/lib/layman</filename>. overlord uses a location within the /usr/portage hierarchy instead of <filename>/var</filename> in order to store its data. This decision has been made to support network file systems. If you have your portage tree on nfs or a similar file system and several machines access the same ebuild repository over the net it will be necessary - to also provide all necessary <command>layman</command> + to also provide all necessary <command>overlord</command> data within the hierarchy of the tree. This way the overlays will also have to be synced at one location only.</para> @@ -576,7 +576,7 @@ <varlistentry> <term><option>cache</option></term> <listitem> - <para><command>layman</command> will store the downloaded + <para><command>overlord</command> will store the downloaded global list of overlays here. The default is <filename>%(storage)s/cache.xml</filename>.</para> </listitem> @@ -585,7 +585,7 @@ <varlistentry> <term><option>overlays</option></term> <listitem> - <para><command>layman</command> will store the list of + <para><command>overlord</command> will store the list of installed overlays here. The default is <filename>%(storage)s/overlays.xml</filename>.</para> </listitem> @@ -595,7 +595,7 @@ <term><option>make.conf</option></term> <listitem> <para>This is the portage configuration file that - <command>layman</command> will modify in order to make + <command>overlord</command> will modify in order to make the new overlays available within portage. The default is <filename>%(storage)s/make.conf</filename>. You could also specify <filename>/etc/make.conf @@ -606,7 +606,7 @@ very small external file that only contains the setting for PORTAGE_OVERLAYS. This file is then sourced at the end of <filename>/etc/make.conf</filename>. This is the - reason why <command>layman</command> suggests running + reason why <command>overlord</command> suggests running "echo "source <filename>/var/lib/layman/make.conf</filename>" >> <filename>/etc/make.conf</filename>" after it has been @@ -638,7 +638,7 @@ <varlistentry> <term><option>nocheck</option></term> <listitem> - <para>Set to "yes" if <command>layman</command> should stop + <para>Set to "yes" if <command>overlord</command> should stop worrying about overlays with missing a contact address or the description.</para> </listitem> @@ -648,19 +648,19 @@ </refsection> - <refsection id="layman-handling"> + <refsection id="overlord-handling"> <title>Handling overlays</title> - <para><command>layman</command> intends to provide easy + <para><command>overlord</command> intends to provide easy maintenance of Gentoo overlays while not requiring any configuration. </para> - <refsection id="layman-remote"> + <refsection id="overlord-remote"> <title>Overlay lists</title> - <para><command>layman</command> allows you to fetch an + <para><command>overlord</command> allows you to fetch an overlay without the need to modify any configuration files. In order for this to be possible the script needs an external list of possible overlay sources. There is a @@ -669,11 +669,11 @@ but nothing will prevent you from using or publishing your own list of overlays. The location of the remote lists can also be modified using the <option>--overlays</option> - option when running <command>layman</command>. + option when running <command>overlord</command>. </para> <para>To get a new overlay added to the central list provided - for layman, send a mail to + for overlord, send a mail to <email>overlays@gentoo.org</email>. Gentoo developers may add their overlay entries directly into the list which can be accessed over the CVS repository for the Gentoo @@ -682,11 +682,11 @@ <para>You can also use several lists at the same time. Just add one URL per line to the overlays variable in your - configuration file. <command>layman</command> will merge the - contents of all lists. + configuration file. <command>overlord</command> will merge the + contents of all lists. </para> - <para><command>layman</command> also allows you to define + <para><command>overlord</command> also allows you to define local files in this list. Just make sure you prepend these path names in standard URL notation with <filename>file://</filename>. @@ -694,32 +694,32 @@ <para>If you need to use a proxy for access to the Internet, you can use the corresponding variable in - the <command>layman</command> configuration file. Layman + the <command>overlord</command> configuration file. overlord will also respect the <command>http_proxy</command> environment variable in case you set it. </para> </refsection> - <refsection id="layman-local"> + <refsection id="overlord-local"> <title>Local cache</title> - <para><command>layman</command> stores a local copy of the + <para><command>overlord</command> stores a local copy of the fetched remote list. It will be stored in <filename>/var/lib/layman/cache.xml</filename> by default. There exists only one such cache file and it will be overwritten every time you - run <command>layman</command>. + run <command>overlord</command>. </para> </refsection> - <refsection id="layman-make-conf"> + <refsection id="overlord-make-conf"> <title>Handling <filename>/etc/make.conf</filename></title> - <para>Since <command>layman</command> is designed to + <para>Since <command>overlord</command> is designed to automatically handle the inclusion of overlays into your system it needs to be able to modify the <command>PORTDIR_OVERLAY</command> variable in your @@ -728,72 +728,72 @@ essential configuration file for a Gentoo system. Automatically modifying this file would be somewhat dangerous. You can - allow <command>layman</command> to do this by setting + allow <command>overlord</command> to do this by setting the <command>make_conf</command> variable in the configuration file to <filename>/etc/make.conf</filename>. </para> <para>A much safer and in fact recommended solution to the - problem is to let <command>layman</command> handle an + problem is to let <command>overlord</command> handle an external file that only contains the <command>PORTDIR_OVERLAY</command> variable and is sourced within the - standard <filename>/etc/make.conf</filename> file. Just add the following line to the end of your + standard <filename>/etc/make.conf</filename> file. Just add the following line to the end of your <filename>/etc/make.conf</filename> file: </para> <para>source /var/lib/layman/make.conf</para> <para><filename>/var/lib/layman/make.conf</filename> - is the default provided in the layman + is the default provided in the overlord configuration. Change this file name in case you decide to store it somewhere else. </para> <para>The file does not necessarily need to exist at the - beginning. If it is missing, layman will create it for you. + beginning. If it is missing, overlord will create it for you. </para> <para>There is also no need to remove the original <command>PORTDIR_OVERLAY</command> variable from - the make.conf file. Layman will simply add new overlays to + the make.conf file. overlord will simply add new overlays to this variable and all your old entries will remain in there. </para> </refsection> - <refsection id="layman-update"> + <refsection id="overlord-update"> <title>Adding, removing and updating overlays</title> <para>Once a remote list of overlays has been fetched, - <command>layman</command> allows to add overlays from the + <command>overlord</command> allows to add overlays from the remote list to your system. The script will try to fetch the overlay. If this is successful the overlay information will be copied from the cache to the list of locally installed overlays. In addition - <command>layman</command> will modify the + <command>overlord</command> will modify the <command>PORTDIR_OVERLAY</command> variable to include the new overlay path. </para> - <para>Removing the overlay with <command>layman</command> will + <para>Removing the overlay with <command>overlord</command> will delete the overlay without leaving any traces behind. </para> <para>In order to update all overlays managed by - <command>layman</command> you can run the script with the + <command>overlord</command> you can run the script with the <option>--sync ALL</option> option or the <option>--sync-all</option> flag. </para> </refsection> - <refsection id="layman-list"> + <refsection id="overlord-list"> <title>List overlays</title> - <para><command>layman</command> provides the + <para><command>overlord</command> provides the <option>--list</option> and <option>--list-local</option> options to print a list of available respectively installed overlays. @@ -806,19 +806,19 @@ with a red asterisk. </para> - <para> In the default mode layman will be strict about + <para> In the default mode overlord will be strict about listing overlays and only present you with overlays that are fully supported. In addition it will complain about overlays that are missing a description field or a contact attribute. This type of behavior has been added with - layman-1.0.7 and if you'd like to return to the old + overlord-1.0.7 and if you'd like to return to the old behavior you may use the k option flag or set the nocheck option in the configuration file. </para> </refsection> - <refsection id="layman-search"> + <refsection id="overlord-search"> <title>Searching ebuilds in overlays</title> @@ -831,14 +831,14 @@ </refsection> - <refsection id="layman-types"> + <refsection id="overlord-types"> <title>Overlay types</title> - <para>Currently <command>layman</command> supports overlays that + <para>Currently <command>overlord</command> supports overlays that are exported via <command>rsync</command>, - <command>subversion</command>, <command>bzr</command>, - <command>darcs</command>, <command>git</command>, + <command>subversion</command>, <command>bzr</command>, + <command>darcs</command>, <command>git</command>, <command>mercurial</command> or provided as <command>tar</command> packages. </para> @@ -847,7 +847,7 @@ </refsection> - <refsection id="layman-global"> + <refsection id="overlord-global"> <title>Overlay lists</title> @@ -856,7 +856,7 @@ <title>Overlay list format</title> <para> - Layman uses a central list of overlays in XML format. The file looks like this: + overlord uses a central list of overlays in XML format. The file looks like this: <example> <title>An example overlays.xml file</title> <programlisting> @@ -890,7 +890,7 @@ <para> Simply create an overlay list in the format described - above and run <command>layman</command> with the + above and run <command>overlord</command> with the <option>-o</option> switch. You need to prepend local file URLs with <userinput>file://</userinput>. @@ -904,7 +904,7 @@ <para> The global list of overlays used by - <command>layman</command> lies at + <command>overlord</command> lies at <filename>http://www.gentoo.org/proj/en/overlays/repositories.xml</filename>. </para> @@ -925,7 +925,7 @@ </refsection> - <refsection id="layman-examples"> + <refsection id="overlord-examples"> <title>Examples</title> @@ -933,7 +933,7 @@ <title>Installing an overlay</title> - <para><userinput>layman -f -a wrobel</userinput></para> + <para><userinput>overlord -f -a wrobel</userinput></para> <para>This would add the overlay with the id <command>wrobel</command> to your list of installed overlays.</para> @@ -944,7 +944,7 @@ <title>Syncing your overlays</title> - <para><userinput>layman -s ALL</userinput></para> + <para><userinput>overlord -s ALL</userinput></para> <para>This updates all overlays</para> </refsection> @@ -953,7 +953,7 @@ <title>Performing several actions at the same time</title> - <para><userinput>layman -f -a wrobel -a webapps-experimental</userinput></para> + <para><userinput>overlord -f -a wrobel -a webapps-experimental</userinput></para> <para>This fetches the remote list and immediately adds two overlays</para> @@ -961,7 +961,7 @@ </refsection> - <refsection id="layman-files"> + <refsection id="overlord-files"> <title>Files</title> @@ -982,7 +982,7 @@ <refsection id="layman-bugs"> <title>Reporting bugs</title> - + <para> Please report bugs you might find at <ulink url="http://bugs.gentoo.org"/> </para> |