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

204
docbook/buildpkg.xml
View file

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

152
docbook/buildtree.xml
View file

@ -1,110 +1,110 @@
<?xml version='1.0'?> <!--*-nxml-*--> <?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" <!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 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 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 the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
manjaro-tools is distributed in the hope that it will be useful, but manjaro-tools is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details. Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>. along with systemd; If not, see <http://www.gnu.org/licenses/>.
--> -->
<refentry id="buildtree" xmlns:xi="http://www.w3.org/2001/XInclude"> <refentry id="buildtree" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo> <refentryinfo>
<title>buildtree-+</title> <title>buildtree-+</title>
<productname>manjaro-tools</productname> <productname>manjaro-tools</productname>
<authorgroup> <authorgroup>
<author> <author>
<contrib></contrib> <contrib></contrib>
<firstname></firstname> <firstname></firstname>
<surname></surname> <surname></surname>
<email></email> <email></email>
</author> </author>
</authorgroup> </authorgroup>
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle>buildtree</refentrytitle> <refentrytitle>buildtree</refentrytitle>
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>buildtree</refname> <refname>buildtree</refname>
<refpurpose>buildtree is used to sync the manjaro and arch package build tree. </refpurpose> <refpurpose>buildtree is used to sync the manjaro and arch package build tree. </refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>buildtree</command> <command>buildtree</command>
<arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1> <refsect1>
<title>Description</title> <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> <refsect1>
<title>Options</title> <title>Options</title>
<para>The following options are understood:</para> <para>The following options are understood:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-s</option></term> <term><option>-s</option></term>
<listitem><para>Sync Manjaro linux tree.</para></listitem> <listitem><para>Sync Manjaro linux tree.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-a</option></term> <term><option>-a</option></term>
<listitem><para>Sync Arch linux tree.</para></listitem> <listitem><para>Sync Arch linux tree.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-c</option></term> <term><option>-c</option></term>
<listitem><para>Clean package trees.</para></listitem> <listitem><para>Clean package trees.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-q</option></term> <term><option>-q</option></term>
<listitem><para>Query settings.</para></listitem> <listitem><para>Query settings.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-h</option></term> <term><option>-h</option></term>
<listitem><para>Help.</para></listitem> <listitem><para>Help.</para></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>See Also</title> <title>See Also</title>
<para> <para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para> </para>
</refsect1> </refsect1>
</refentry> </refentry>

192
docbook/check-yaml.xml
View file

@ -1,145 +1,145 @@
<?xml version='1.0'?> <!--*-nxml-*--> <?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" <!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 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 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 the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
manjaro-tools is distributed in the hope that it will be useful, but manjaro-tools is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details. Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>. along with systemd; If not, see <http://www.gnu.org/licenses/>.
--> -->
<refentry id="check-yaml" xmlns:xi="http://www.w3.org/2001/XInclude"> <refentry id="check-yaml" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo> <refentryinfo>
<title>check-yaml-+</title> <title>check-yaml-+</title>
<productname>manjaro-tools</productname> <productname>manjaro-tools</productname>
<authorgroup> <authorgroup>
<author> <author>
<contrib></contrib> <contrib></contrib>
<firstname></firstname> <firstname></firstname>
<surname></surname> <surname></surname>
<email></email> <email></email>
</author> </author>
</authorgroup> </authorgroup>
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle>check-yaml</refentrytitle> <refentrytitle>check-yaml</refentrytitle>
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>check-yaml</refname> <refname>check-yaml</refname>
<refpurpose>check-yaml is used to generate and validate yaml files used by calamares. </refpurpose> <refpurpose>check-yaml is used to generate and validate yaml files used by calamares. </refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>check-yaml</command> <command>check-yaml</command>
<arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1> <refsect1>
<title>Description</title> <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> <refsect1>
<title>Options</title> <title>Options</title>
<para>The following options are understood:</para> <para>The following options are understood:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-p PROFILE...</option></term> <term><option>-p PROFILE...</option></term>
<listitem><para>Name of the build list or name of the directory.</para></listitem> <listitem><para>Name of the build list or name of the directory.</para></listitem>
</varlistentry> </varlistentry>
<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> <listitem><para>Architecture that the yaml will be created for. Can be i686 or x86_64.</para></listitem>
</varlistentry> </varlistentry>
<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> <listitem><para>The init system the yaml will be created for.</para></listitem>
</varlistentry> </varlistentry>
<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> <listitem><para>The kernel the yaml will be created for.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-c</option></term> <term><option>-c</option></term>
<listitem><para>Create calamares yaml conf files.</para></listitem> <listitem><para>Create calamares yaml conf files.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-g</option></term> <term><option>-g</option></term>
<listitem><para>Generate a packman group netgroup yaml file.</para></listitem> <listitem><para>Generate a packman group netgroup yaml file.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-v</option></term> <term><option>-v</option></term>
<listitem><para>Validate the yaml file by yaml schema.</para></listitem> <listitem><para>Validate the yaml file by yaml schema.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-q</option></term> <term><option>-q</option></term>
<listitem><para>Query settings.</para></listitem> <listitem><para>Query settings.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-h</option></term> <term><option>-h</option></term>
<listitem><para>Help.</para></listitem> <listitem><para>Help.</para></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
<!--<refsect1> <!--<refsect1>
<title>Exit status</title> <title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code <para>On success, 0 is returned, a non-zero failure code
otherwise.</para> otherwise.</para>
</refsect1> </refsect1>
--> -->
<refsect1> <refsect1>
<title>See Also</title> <title>See Also</title>
<para> <para>
<citerefentry project='manjaro-tools'><refentrytitle>manjaro-tools.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <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>, <citerefentry project='manjaro-tools'><refentrytitle>profiles.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para> </para>
</refsect1> </refsect1>
</refentry> </refentry>

186
docbook/deployiso.xml
View file

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

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

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

370
docbook/profile.conf.xml
View file

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