root/manjaro-tools
1
0
Fork 0
forked from mirrored-repos/manjaro-tools
Code Pull requests Activity

docbook: remove tabs

Browse source
This commit is contained in:
udeved 2016-09-30 18:34:55 +02:00
parent 0af93a061b
commit e6642071ca
7 changed files with 911 additions and 911 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

254
docbook/buildiso.xml
View file

@ -1,187 +1,187 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of manjaro-tools.
This file is part of manjaro-tools.
Copyright 2015 Manjaro Developers
Copyright 2015 Manjaro Developers
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools 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
Lesser General Public License for more details.
manjaro-tools 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="buildiso" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>buildiso-+</title>
<productname>manjaro-tools</productname>
<refentryinfo>
<title>buildiso-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>buildiso</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refmeta>
<refentrytitle>buildiso</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>buildiso</refname>
<refpurpose>buildiso is used to build a particular ISO or a set of ISOs. </refpurpose>
</refnamediv>
<refnamediv>
<refname>buildiso</refname>
<refpurpose>buildiso is used to build a particular ISO or a set of ISOs. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>buildiso</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsynopsisdiv>
<cmdsynopsis>
<command>buildiso</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect1>
<title>Description</title>
<para><command>buildiso</command> is used to build a particular ISO or a set of ISOs. </para>
<para><command>buildiso</command> is used to build a particular ISO or a set of ISOs. </para>
<para>With buildiso you can build ISOs suitable to be booted from a removable media
like a DVD o a USB Stick, it will automatically create the necessary files to
install this ISO using calamares or the cli installer.</para>
<para>With buildiso you can build ISOs suitable to be booted from a removable media
like a DVD o a USB Stick, it will automatically create the necessary files to
install this ISO using calamares or the cli installer.</para>
</refsect1>
</refsect1>
<refsect1>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<listitem><para>Name of the build list or name of the directory
you will build. It needs to cantains a existing build list or a
folder with a valid profile.</para></listitem>
</varlistentry>
<listitem><para>Name of the build list or name of the directory
you will build. It needs to cantains a existing build list or a
folder with a valid profile.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a i686|x86_64</option></term>
<varlistentry>
<term><option>-a i686|x86_64</option></term>
<listitem><para>Architecture that the iso will be built. Can be i686 or x86_64.</para></listitem>
</varlistentry>
<listitem><para>Architecture that the iso will be built. Can be i686 or x86_64.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-b stable|testing|unstable</option></term>
<varlistentry>
<term><option>-b stable|testing|unstable</option></term>
<listitem><para>Branch where the mirrors in the iso will point.</para></listitem>
</varlistentry>
<listitem><para>Branch where the mirrors in the iso will point.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-r DIR</option></term>
<varlistentry>
<term><option>-r DIR</option></term>
<listitem><para>Root working directory where the iso will be built.</para></listitem>
</varlistentry>
<listitem><para>Root working directory where the iso will be built.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-t DIR</option></term>
<varlistentry>
<term><option>-t DIR</option></term>
<listitem><para>Iso target directory where the final iso will be stored.</para></listitem>
</varlistentry>
<listitem><para>Iso target directory where the final iso will be stored.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-i systemd|openrc</option></term>
<varlistentry>
<term><option>-i systemd|openrc</option></term>
<listitem><para>The init system on the iso</para></listitem>
</varlistentry>
<listitem><para>The init system on the iso</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option></term>
<varlistentry>
<term><option>-s</option></term>
<listitem><para>Sign the iso.</para></listitem>
</varlistentry>
<listitem><para>Sign the iso.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-k linuxXXX</option></term>
<varlistentry>
<term><option>-k linuxXXX</option></term>
<listitem><para>The kernel on the iso</para></listitem>
</varlistentry>
<listitem><para>The kernel on the iso</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<varlistentry>
<term><option>-c</option></term>
<listitem><para>Disable clean working directory step.</para></listitem>
</varlistentry>
<listitem><para>Disable clean working directory step.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option></term>
<varlistentry>
<term><option>-x</option></term>
<listitem><para>Only build images, without creating an ISO file.</para></listitem>
</varlistentry>
<listitem><para>Only build images, without creating an ISO file.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-z</option></term>
<varlistentry>
<term><option>-z</option></term>
<listitem><para>Generate iso from already created images, for example created with the -x option.</para></listitem>
</varlistentry>
<listitem><para>Generate iso from already created images, for example created with the -x option.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<varlistentry>
<term><option>-w</option></term>
<listitem><para>Create a torrent from iso file.</para></listitem>
</varlistentry>
<listitem><para>Create a torrent from iso file.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<varlistentry>
<term><option>-v</option></term>
<listitem><para>Verbose output to log file, show profile detail in combination with pretend.</para></listitem>
</varlistentry>
<listitem><para>Verbose output to log file, show profile detail in combination with pretend.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<varlistentry>
<term><option>-q</option></term>
<listitem><para>Query settings and pretend build.</para></listitem>
</varlistentry>
<listitem><para>Query settings and pretend build.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<varlistentry>
<term><option>-h</option></term>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refsect1>
<!--<refsect1>
<title>Exit status</title>
<!--<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
-->
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
-->
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>

204
docbook/buildpkg.xml
View file

@ -1,147 +1,147 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of manjaro-tools.
This file is part of manjaro-tools.
Copyright 2015 Manjaro Developers
Copyright 2015 Manjaro Developers
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools 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
Lesser General Public License for more details.
manjaro-tools 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="buildpkg" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>buildpkg-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refentryinfo>
<title>buildpkg-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>buildpkg</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refmeta>
<refentrytitle>buildpkg</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>buildpkg</refname>
<refpurpose>buildpkg is used to build packages in a clean chroot. </refpurpose>
</refnamediv>
<refnamediv>
<refname>buildpkg</refname>
<refpurpose>buildpkg is used to build packages in a clean chroot. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>buildpkg</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsynopsisdiv>
<cmdsynopsis>
<command>buildpkg</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect1>
<title>Description</title>
<para><command>buildpkg</command> is used to build a particular package or a set of packages. </para>
<para><command>buildpkg</command> is used to build a particular package or a set of packages. </para>
<para>With buildpkg you can build packages in a clean chroot environment.</para>
<para>With buildpkg you can build packages in a clean chroot environment.</para>
</refsect1>
</refsect1>
<refsect1>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<listitem><para>Name of the build list or name of the directory
you will build. It needs to cantain a existing build list or a
folder with a valid PKGBUILD.</para></listitem>
</varlistentry>
<listitem><para>Name of the build list or name of the directory
you will build. It needs to cantain a existing build list or a
folder with a valid PKGBUILD.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a i686|x86_64|multilib|arm|armv6h|armv7h|aarch64</option></term>
<varlistentry>
<term><option>-a i686|x86_64|multilib|arm|armv6h|armv7h|aarch64</option></term>
<listitem><para>Architecture that the iso will be built. Can be i686, x86_64 or multilib.</para></listitem>
</varlistentry>
<listitem><para>Architecture that the iso will be built. Can be i686, x86_64 or multilib.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-b stable|testing|unstable</option></term>
<varlistentry>
<term><option>-b stable|testing|unstable</option></term>
<listitem><para>Branch to build against..</para></listitem>
</varlistentry>
<listitem><para>Branch to build against..</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-r DIR</option></term>
<varlistentry>
<term><option>-r DIR</option></term>
<listitem><para>Root working directory where the package will be built.</para></listitem>
</varlistentry>
<listitem><para>Root working directory where the package will be built.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-i PKG</option></term>
<varlistentry>
<term><option>-i PKG</option></term>
<listitem><para>Install a package into the working copy of the chroot.</para></listitem>
</varlistentry>
<listitem><para>Install a package into the working copy of the chroot.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<varlistentry>
<term><option>-c</option></term>
<listitem><para>Recreate chroot.</para></listitem>
</varlistentry>
<listitem><para>Recreate chroot.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<varlistentry>
<term><option>-w</option></term>
<listitem><para>Clean up cache and sources.</para></listitem>
</varlistentry>
<listitem><para>Clean up cache and sources.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<varlistentry>
<term><option>-n</option></term>
<listitem><para>Install built package in chroot and run namcap check.</para></listitem>
</varlistentry>
<listitem><para>Install built package in chroot and run namcap check.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option></term>
<varlistentry>
<term><option>-s</option></term>
<listitem><para>Sign package.</para></listitem>
</varlistentry>
<listitem><para>Sign package.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<varlistentry>
<term><option>-q</option></term>
<listitem><para>Query settings and pretend build.</para></listitem>
</varlistentry>
<listitem><para>Query settings and pretend build.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<varlistentry>
<term><option>-h</option></term>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>

152
docbook/buildtree.xml
View file

@ -1,110 +1,110 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of manjaro-tools.
This file is part of manjaro-tools.
Copyright 2015 Manjaro Developers
Copyright 2015 Manjaro Developers
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools 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
Lesser General Public License for more details.
manjaro-tools 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="buildtree" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>buildtree-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refentryinfo>
<title>buildtree-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>buildtree</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refmeta>
<refentrytitle>buildtree</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>buildtree</refname>
<refpurpose>buildtree is used to sync the manjaro and arch package build tree. </refpurpose>
</refnamediv>
<refnamediv>
<refname>buildtree</refname>
<refpurpose>buildtree is used to sync the manjaro and arch package build tree. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>buildtree</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsynopsisdiv>
<cmdsynopsis>
<command>buildtree</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect1>
<title>Description</title>
<para><command>buildtree</command> is used to sync package trees. </para>
<para><command>buildtree</command> is used to sync package trees. </para>
<para>With buildtree, you can sync the manjaro and arch linux packae build trees.</para>
<para>With buildtree, you can sync the manjaro and arch linux packae build trees.</para>
</refsect1>
</refsect1>
<refsect1>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-s</option></term>
<variablelist>
<varlistentry>
<term><option>-s</option></term>
<listitem><para>Sync Manjaro linux tree.</para></listitem>
</varlistentry>
<listitem><para>Sync Manjaro linux tree.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option></term>
<varlistentry>
<term><option>-a</option></term>
<listitem><para>Sync Arch linux tree.</para></listitem>
</varlistentry>
<listitem><para>Sync Arch linux tree.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<varlistentry>
<term><option>-c</option></term>
<listitem><para>Clean package trees.</para></listitem>
</varlistentry>
<listitem><para>Clean package trees.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<varlistentry>
<term><option>-q</option></term>
<listitem><para>Query settings.</para></listitem>
</varlistentry>
<listitem><para>Query settings.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<varlistentry>
<term><option>-h</option></term>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>

192
docbook/check-yaml.xml
View file

@ -1,145 +1,145 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of manjaro-tools.
This file is part of manjaro-tools.
Copyright 2015 Manjaro Developers
Copyright 2015 Manjaro Developers
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools 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
Lesser General Public License for more details.
manjaro-tools 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="check-yaml" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>check-yaml-+</title>
<productname>manjaro-tools</productname>
<refentryinfo>
<title>check-yaml-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>check-yaml</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refmeta>
<refentrytitle>check-yaml</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>check-yaml</refname>
<refpurpose>check-yaml is used to generate and validate yaml files used by calamares. </refpurpose>
</refnamediv>
<refnamediv>
<refname>check-yaml</refname>
<refpurpose>check-yaml is used to generate and validate yaml files used by calamares. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>check-yaml</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsynopsisdiv>
<cmdsynopsis>
<command>check-yaml</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect1>
<title>Description</title>
<para><command>check-yaml</command> is used to generate and validate yaml files used by calamares.</para>
<para><command>check-yaml</command> is used to generate and validate yaml files used by calamares.</para>
<para>check-yaml is a script to generate and validate yaml files by yaml schemas. Buildiso generates these files also, but check-yaml is a standalone version without the need to build the entire iso.</para>
<para>check-yaml is a script to generate and validate yaml files by yaml schemas. Buildiso generates these files also, but check-yaml is a standalone version without the need to build the entire iso.</para>
</refsect1>
</refsect1>
<refsect1>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<listitem><para>Name of the build list or name of the directory.</para></listitem>
</varlistentry>
<listitem><para>Name of the build list or name of the directory.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a i686|x86_64</option></term>
<term><option>-a i686|x86_64</option></term>
<listitem><para>Architecture that the yaml will be created for. Can be i686 or x86_64.</para></listitem>
</varlistentry>
<listitem><para>Architecture that the yaml will be created for. Can be i686 or x86_64.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-i systemd|openrc</option></term>
<term><option>-i systemd|openrc</option></term>
<listitem><para>The init system the yaml will be created for.</para></listitem>
</varlistentry>
<listitem><para>The init system the yaml will be created for.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-k linuxXXX</option></term>
<term><option>-k linuxXXX</option></term>
<listitem><para>The kernel the yaml will be created for.</para></listitem>
</varlistentry>
<listitem><para>The kernel the yaml will be created for.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<varlistentry>
<term><option>-c</option></term>
<listitem><para>Create calamares yaml conf files.</para></listitem>
</varlistentry>
<listitem><para>Create calamares yaml conf files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-g</option></term>
<varlistentry>
<term><option>-g</option></term>
<listitem><para>Generate a packman group netgroup yaml file.</para></listitem>
</varlistentry>
<listitem><para>Generate a packman group netgroup yaml file.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<varlistentry>
<term><option>-v</option></term>
<listitem><para>Validate the yaml file by yaml schema.</para></listitem>
</varlistentry>
<listitem><para>Validate the yaml file by yaml schema.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<varlistentry>
<term><option>-q</option></term>
<listitem><para>Query settings.</para></listitem>
</varlistentry>
<listitem><para>Query settings.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<varlistentry>
<term><option>-h</option></term>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refsect1>
<!--<refsect1>
<title>Exit status</title>
<!--<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
-->
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
-->
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>

186
docbook/deployiso.xml
View file

@ -1,135 +1,135 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of manjaro-tools.
This file is part of manjaro-tools.
Copyright 2015 Manjaro Developers
Copyright 2015 Manjaro Developers
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools 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
Lesser General Public License for more details.
manjaro-tools 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="deployiso" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>deployiso-+</title>
<productname>manjaro-tools</productname>
<refentryinfo>
<title>deployiso-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>deployiso</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refmeta>
<refentrytitle>deployiso</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>deployiso</refname>
<refpurpose>deployiso is used to upload a particular ISO or a set of ISOs. </refpurpose>
</refnamediv>
<refnamediv>
<refname>deployiso</refname>
<refpurpose>deployiso is used to upload a particular ISO or a set of ISOs. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>deployiso</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsynopsisdiv>
<cmdsynopsis>
<command>deployiso</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect1>
<title>Description</title>
<para><command>deployiso</command> is used to upload a particular ISO or a set of ISOs. </para>
<para><command>deployiso</command> is used to upload a particular ISO or a set of ISOs. </para>
<para>deployiso is a script to upload a specific iso or a buiildset to SF.
It needs to be run inside the iso-profiles directory.</para>
<para>deployiso is a script to upload a specific iso or a buiildset to SF.
It needs to be run inside the iso-profiles directory.</para>
</refsect1>
</refsect1>
<refsect1>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<variablelist>
<varlistentry>
<term><option>-p PROFILE...</option></term>
<listitem><para>Name of the build list or name of the directory
you will upload.</para></listitem>
</varlistentry>
<listitem><para>Name of the build list or name of the directory
you will upload.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<varlistentry>
<term><option>-c</option></term>
<listitem><para>Create new remote release.</para></listitem>
</varlistentry>
<listitem><para>Create new remote release.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option></term>
<varlistentry>
<term><option>-l</option></term>
<listitem><para>Limit bandwidth in kB/s.</para></listitem>
</varlistentry>
<listitem><para>Limit bandwidth in kB/s.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option></term>
<varlistentry>
<term><option>-u</option></term>
<listitem><para>Update remote iso.</para></listitem>
</varlistentry>
<listitem><para>Update remote iso.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<varlistentry>
<term><option>-v</option></term>
<listitem><para>Verbose output.</para></listitem>
</varlistentry>
<listitem><para>Verbose output.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<varlistentry>
<term><option>-q</option></term>
<listitem><para>Query settings and pretend upload.</para></listitem>
</varlistentry>
<listitem><para>Query settings and pretend upload.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<varlistentry>
<term><option>-h</option></term>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
<listitem><para>Help.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</refsect1>
<!--<refsect1>
<title>Exit status</title>
<!--<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
-->
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
-->
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>

464
docbook/manjaro-tools.conf.xml
View file

@ -1,323 +1,323 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of manjaro-tools.
This file is part of manjaro-tools.
Copyright 2015 Manjaro Developers
Copyright 2015 Manjaro Developers
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools 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
Lesser General Public License for more details.
manjaro-tools 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="profile.conf" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>profile.conf-+</title>
<productname>manjaro-tools</productname>
<refentryinfo>
<title>profile.conf-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>manjaro-tools.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refmeta>
<refentrytitle>manjaro-tools.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>manjaro-tools.conf</refname>
<refpurpose>general configuration file for manjaro-tools</refpurpose>
</refnamediv>
<refnamediv>
<refname>manjaro-tools.conf</refname>
<refpurpose>general configuration file for manjaro-tools</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>manjaro-tools.conf</filename></para>
</refsynopsisdiv>
<refsynopsisdiv>
<para><filename>manjaro-tools.conf</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect1>
<title>Description</title>
<para>manjaro-tools.conf is a general configuration file for all manjaro-tools binaries. </para>
<para>manjaro-tools.conf is a general configuration file for all manjaro-tools binaries. </para>
<para>By default all the options in the file are commented, with a value equal to the
default value. To change it just uncomment and put the desired value.</para>
<para>By default all the options in the file are commented, with a value equal to the
default value. To change it just uncomment and put the desired value.</para>
</refsect1>
</refsect1>
<refsect1>
<title>General options for all tools</title>
<refsect1>
<title>General options for all tools</title>
<para>The following options are understood and used for various tools:</para>
<para>The following options are understood and used for various tools:</para>
<variablelist>
<varlistentry>
<term><varname>target_branch=</varname></term>
<variablelist>
<varlistentry>
<term><varname>target_branch=</varname></term>
<listitem><para>Takes <option>stable</option> (the default),
<option>testing</option> or <option>unstable</option>. It defines
against which repository will be used when compilling packages
with buildpkg.
</para></listitem>
</varlistentry>
<listitem><para>Takes <option>stable</option> (the default),
<option>testing</option> or <option>unstable</option>. It defines
against which repository will be used when compilling packages
with buildpkg.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>target_arch=</varname></term>
<varlistentry>
<term><varname>target_arch=</varname></term>
<listitem><para>Takes <option>i686</option> or <option>x86_64</option>.
By default it will try to autodetect the current architecture.
It defines in witch architecture the packages will be built with
buildpkg.
</para></listitem>
</varlistentry>
<listitem><para>Takes <option>i686</option> or <option>x86_64</option>.
By default it will try to autodetect the current architecture.
It defines in witch architecture the packages will be built with
buildpkg.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>cache_dir=</varname></term>
<varlistentry>
<term><varname>cache_dir=</varname></term>
<listitem><para>Cache dir where buildpkg and buildise will cache
packages. Default is "/var/cache/manjaro-tools".
</para></listitem>
</varlistentry>
<listitem><para>Cache dir where buildpkg and buildise will cache
packages. Default is "/var/cache/manjaro-tools".
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>chroots_dir=</varname></term>
<varlistentry>
<term><varname>chroots_dir=</varname></term>
<listitem><para>Build dir where buildpkg or buildiso chroot
environment will be created. Default is "/var/lib/manjaro-tools".
</para></listitem>
</varlistentry>
<listitem><para>Build dir where buildpkg or buildiso chroot
environment will be created. Default is "/var/lib/manjaro-tools".
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>log_dir=</varname></term>
<varlistentry>
<term><varname>log_dir=</varname></term>
<listitem><para>Log dir where buildiso log the build process. Default is "/var/log/manjaro-tools".
</para></listitem>
</varlistentry>
<listitem><para>Log dir where buildiso log the build process. Default is "/var/log/manjaro-tools".
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>build_mirror=</varname></term>
<varlistentry>
<term><varname>build_mirror=</varname></term>
<listitem><para>Default mirror to be used when building
packages.
</para></listitem>
</varlistentry>
<listitem><para>Default mirror to be used when building
packages.
</para></listitem>
</varlistentry>
<!--<varlistentry>
<term><varname>host=</varname></term>
<!--<varlistentry>
<term><varname>host=</varname></term>
<listitem><para>Default url to be used for upload.
</para></listitem>
</varlistentry>-->
<listitem><para>Default url to be used for upload.
</para></listitem>
</varlistentry>-->
</variablelist>
</refsect1>
</variablelist>
</refsect1>
<refsect1>
<title>Options for buildtree</title>
<refsect1>
<title>Options for buildtree</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><varname>repo_tree=</varname></term>
<variablelist>
<varlistentry>
<term><varname>repo_tree=</varname></term>
<listitem><para>Manjaro package tree. Default is
"('core' 'extra' 'community' 'multilib' 'openrc')".
</para></listitem>
</varlistentry>
<listitem><para>Manjaro package tree. Default is
"('core' 'extra' 'community' 'multilib' 'openrc')".
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>host_tree=</varname></term>
<varlistentry>
<term><varname>host_tree=</varname></term>
<listitem><para>Host tree. Default is "https://github.com/manjaro".
</para></listitem>
</varlistentry>
<listitem><para>Host tree. Default is "https://github.com/manjaro".
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>host_tree_abs=</varname></term>
<varlistentry>
<term><varname>host_tree_abs=</varname></term>
<listitem><para>Host tree for abs. Default is
"https://projects.archlinux.org/git/svntogit".
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<listitem><para>Host tree for abs. Default is
"https://projects.archlinux.org/git/svntogit".
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Options for buildpkg</title>
<refsect1>
<title>Options for buildpkg</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><varname>build_list_pkg=</varname></term>
<variablelist>
<varlistentry>
<term><varname>build_list_pkg=</varname></term>
<listitem><para>Default list for buildpkg without the .list
extension.
</para></listitem>
</varlistentry>
<listitem><para>Default list for buildpkg without the .list
extension.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</variablelist>
</refsect1>
<refsect1>
<title>Options for buildiso</title>
<refsect1>
<title>Options for buildiso</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><varname>build_list_iso=</varname></term>
<variablelist>
<varlistentry>
<term><varname>build_list_iso=</varname></term>
<listitem><para>Default list for buildiso without the .list
extension.
</para></listitem>
</varlistentry>
<listitem><para>Default list for buildiso without the .list
extension.
</para></listitem>
</varlistentry>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>dist_name=</varname></term>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>dist_name=</varname></term>
<listitem><para>Name of the distribution.
</para></listitem>
</varlistentry>
<listitem><para>Name of the distribution.
</para></listitem>
</varlistentry>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>dist_release=</varname></term>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>dist_release=</varname></term>
<listitem><para>Release of the distribution.
</para></listitem>
</varlistentry>
<listitem><para>Release of the distribution.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>dist_codename=</varname></term>
<varlistentry>
<term><varname>dist_codename=</varname></term>
<listitem><para>Codename of this release. It's the value
of DISTRIB_CODENAME in /etc/lsb-release.
</para></listitem>
</varlistentry>
<listitem><para>Codename of this release. It's the value
of DISTRIB_CODENAME in /etc/lsb-release.
</para></listitem>
</varlistentry>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>dist_branding=</varname></term>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>dist_branding=</varname></term>
<listitem><para>Branding of the distribution.
</para></listitem>
</varlistentry>
<listitem><para>Branding of the distribution.
</para></listitem>
</varlistentry>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>iso_publisher=</varname></term>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>iso_publisher=</varname></term>
<listitem><para>Publisher of the iso.
</para></listitem>
</varlistentry>
<listitem><para>Publisher of the iso.
</para></listitem>
</varlistentry>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>iso_app_id=</varname></term>
<varlistentry>
<!-- TODO: We should tell where exactly this is used -->
<term><varname>iso_app_id=</varname></term>
<listitem><para>Application ID of the iso.
</para></listitem>
</varlistentry>
<listitem><para>Application ID of the iso.
</para></listitem>
</varlistentry>
<varlistentry>
<!-- TODO: Need list of other available compressions -->
<term><varname>iso_compression=</varname></term>
<varlistentry>
<!-- TODO: Need list of other available compressions -->
<term><varname>iso_compression=</varname></term>
<listitem><para>Defaults compression that will be used
when creating the various images. Defaults to xz.
</para></listitem>
</varlistentry>
<listitem><para>Defaults compression that will be used
when creating the various images. Defaults to xz.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>iso_checksum=</varname></term>
<varlistentry>
<term><varname>iso_checksum=</varname></term>
<listitem><para>Checksum that will be created against the
final .iso file. Can be <option>md5</option> (the default),
<option>sha1</option>, <option>sha256</option>,
<option>sha384</option> or <option>sha512</option>.
</para></listitem>
</varlistentry>
<listitem><para>Checksum that will be created against the
final .iso file. Can be <option>md5</option> (the default),
<option>sha1</option>, <option>sha256</option>,
<option>sha384</option> or <option>sha512</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>initsys=</varname></term>
<varlistentry>
<term><varname>initsys=</varname></term>
<listitem><para>Takes <option>systemd</option> (the default)
or <option>openrc</option>. Selecting and option will change
how the hostname, the displaymanager and services will be configured.
For services also controls if buildiso will use enable_systemd and
enable_systemd_live or enable_openrc and enable_openrc_live to determine
the default services that will be enabled automatically.
</para></listitem>
</varlistentry>
<listitem><para>Takes <option>systemd</option> (the default)
or <option>openrc</option>. Selecting and option will change
how the hostname, the displaymanager and services will be configured.
For services also controls if buildiso will use enable_systemd and
enable_systemd_live or enable_openrc and enable_openrc_live to determine
the default services that will be enabled automatically.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>kernel=</varname></term>
<varlistentry>
<term><varname>kernel=</varname></term>
<listitem><para>Takes a string corresponding to a
manjaro kernel package (ex: linux318 for linux 3.18).
</para></listitem>
</varlistentry>
<listitem><para>Takes a string corresponding to a
manjaro kernel package (ex: linux318 for linux 3.18).
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</variablelist>
</refsect1>
<refsect1>
<title>Options for deployiso</title>
<refsect1>
<title>Options for deployiso</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<variablelist>
<varlistentry>
<term><varname>account=</varname></term>
<varlistentry>
<term><varname>account=</varname></term>
<listitem><para>Default user to be used for upload.
</para></listitem>
</varlistentry>
<listitem><para>Default user to be used for upload.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>limit=</varname></term>
<varlistentry>
<term><varname>limit=</varname></term>
<listitem><para>Default upload bandwidth limit in kb/s.
</para></listitem>
</varlistentry>
<listitem><para>Default upload bandwidth limit in kb/s.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildiso</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>deployiso</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildtree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildpkg</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildiso</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>deployiso</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildtree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildpkg</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>

370
docbook/profile.conf.xml
View file

@ -1,246 +1,246 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of manjaro-tools.
This file is part of manjaro-tools.
Copyright 2015 Manjaro Developers
Copyright 2015 Manjaro Developers
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
manjaro-tools 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
Lesser General Public License for more details.
manjaro-tools 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="profile.conf" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>profile.conf-+</title>
<productname>manjaro-tools</productname>
<refentryinfo>
<title>profile.conf-+</title>
<productname>manjaro-tools</productname>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<authorgroup>
<author>
<contrib></contrib>
<firstname></firstname>
<surname></surname>
<email></email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>profile.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refmeta>
<refentrytitle>profile.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>profile.conf</refname>
<refpurpose>configuration file for the individual profiles </refpurpose>
</refnamediv>
<refnamediv>
<refname>profile.conf</refname>
<refpurpose>configuration file for the individual profiles </refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>profile.conf</filename></para>
</refsynopsisdiv>
<refsynopsisdiv>
<para><filename>profile.conf</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect1>
<title>Description</title>
<para>profile.conf is a configuration file used to modify how the ISO will be built. </para>
<para>profile.conf is a configuration file used to modify how the ISO will be built. </para>
<para>By default all the options in the file are commented, with a value equal to the
default value. To change it just uncomment and put the desired value.</para>
<para>By default all the options in the file are commented, with a value equal to the
default value. To change it just uncomment and put the desired value.</para>
</refsect1>
</refsect1>
<refsect1>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<para>The following options are understood:</para>
<variablelist>
<variablelist>
<varlistentry>
<term><varname>displaymanager=</varname></term>
<varlistentry>
<term><varname>displaymanager=</varname></term>
<listitem><para>Takes a value of
<option>lightdm</option>,
<option>sddm</option>,
<option>gdm</option>,
<option>mdm</option>,
<option>lxdm</option>. Defaults to "none" value,
which won't configure any display manager.
</para></listitem>
</varlistentry>
<listitem><para>Takes a value of
<option>lightdm</option>,
<option>sddm</option>,
<option>gdm</option>,
<option>mdm</option>,
<option>lxdm</option>. Defaults to "none" value,
which won't configure any display manager.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>autologin=</varname></term>
<varlistentry>
<term><varname>autologin=</varname></term>
<listitem><para>Accepts
<option>true</option> (the default)
<option>false</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>netinstall=</varname></term>
<listitem><para>Accepts
<option>false</option> (the default)
<option>true</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>chrootcfg=</varname></term>
<listitem><para>Accepts
<option>false</option> (the default)
<option>true</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>netgroups=</varname></term>
<listitem><para>Default url for the netinstall.yaml.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>geoip=</varname></term>
<listitem><para>Accepts
<listitem><para>Accepts
<option>true</option> (the default)
<option>false</option>.</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>efi_boot_loader=</varname></term>
<varlistentry>
<term><varname>netinstall=</varname></term>
<listitem><para>Takes grub or gummibot. Configures
calamares to use that bootloader.
</para></listitem>
</varlistentry>
<listitem><para>Accepts
<option>false</option> (the default)
<option>true</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>plymouth_theme=</varname></term>
<varlistentry>
<term><varname>chrootcfg=</varname></term>
<listitem><para>Takes the name of the plymouth
theme. It should be the directory of a valid
plymouth theme installed in /usr/share/plymouth/themes/
</para></listitem>
</varlistentry>
<listitem><para>Accepts
<option>false</option> (the default)
<option>true</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>enable_systemd=</varname></term>
<varlistentry>
<term><varname>netgroups=</varname></term>
<listitem><para>Array of services that will be
enabled in systemd systems. It has to match
the names of .service systemd files.
</para></listitem>
</varlistentry>
<listitem><para>Default url for the netinstall.yaml.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>enable_openrc=</varname></term>
<varlistentry>
<term><varname>geoip=</varname></term>
<listitem><para>Array of services that will be
enabled in openrc systems.
</para></listitem>
</varlistentry>
<listitem><para>Accepts
<option>true</option> (the default)
<option>false</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>hostname=</varname></term>
<varlistentry>
<term><varname>efi_boot_loader=</varname></term>
<listitem><para>Hostname for the ISO.
</para></listitem>
</varlistentry>
<listitem><para>Takes grub or gummibot. Configures
calamares to use that bootloader.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>username=</varname></term>
<varlistentry>
<term><varname>plymouth_theme=</varname></term>
<listitem><para>Username of the default user
that will be created in the live-cd.
</para></listitem>
</varlistentry>
<listitem><para>Takes the name of the plymouth
theme. It should be the directory of a valid
plymouth theme installed in /usr/share/plymouth/themes/
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>password=</varname></term>
<varlistentry>
<term><varname>enable_systemd=</varname></term>
<listitem><para>Password of the default user
that will be created in the live-cd.
</para></listitem>
</varlistentry>
<listitem><para>Array of services that will be
enabled in systemd systems. It has to match
the names of .service systemd files.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>login_shell=</varname></term>
<varlistentry>
<term><varname>enable_openrc=</varname></term>
<listitem><para>Accepts any login shell for the user, eg. /bin/zsh.
login_shell defaults to /bin/bash
</para></listitem>
</varlistentry>
<listitem><para>Array of services that will be
enabled in openrc systems.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>addgroups=</varname></term>
<varlistentry>
<term><varname>hostname=</varname></term>
<listitem><para>Default groups of the default user
in the live-cd and the user created while installing
the iso using calamares.
</para></listitem>
</varlistentry>
<listitem><para>Hostname for the ISO.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>enable_systemd_live=</varname></term>
<varlistentry>
<term><varname>username=</varname></term>
<listitem><para>Array of services that will be
enabled in the systemd live-cd. It has to match
the names of .service systemd files.
</para></listitem>
</varlistentry>
<listitem><para>Username of the default user
that will be created in the live-cd.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>enable_openrc_live=</varname></term>
<varlistentry>
<term><varname>password=</varname></term>
<listitem><para>Array of services that will be
enabled in the openrc live-cd.
</para></listitem>
</varlistentry>
<listitem><para>Password of the default user
that will be created in the live-cd.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>tracker_url=</varname></term>
<varlistentry>
<term><varname>login_shell=</varname></term>
<listitem><para>Default tracker announce for the torrent.
The tracker url can also contain comma separated urls.
</para></listitem>
</varlistentry>
<listitem><para>Accepts any login shell for the user, eg. /bin/zsh.
login_shell defaults to /bin/bash
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>piece_size=</varname></term>
<varlistentry>
<term><varname>addgroups=</varname></term>
<listitem><para>Default priece size for the torrent in 2^n.
</para></listitem>
</varlistentry>
<listitem><para>Default groups of the default user
in the live-cd and the user created while installing
the iso using calamares.
</para></listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term><varname>enable_systemd_live=</varname></term>
</refsect1>
<listitem><para>Array of services that will be
enabled in the systemd live-cd. It has to match
the names of .service systemd files.
</para></listitem>
</varlistentry>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildiso</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
</para>
</refsect1>
<varlistentry>
<term><varname>enable_openrc_live=</varname></term>
<listitem><para>Array of services that will be
enabled in the openrc live-cd.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>tracker_url=</varname></term>
<listitem><para>Default tracker announce for the torrent.
The tracker url can also contain comma separated urls.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>piece_size=</varname></term>
<listitem><para>Default priece size for the torrent in 2^n.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry project='manjaro-tools'><refentrytitle>buildiso</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>