forked from mirrored-repos/manjaro-tools
Merge pull request #97 from manjaro/manpages
Add buildiso, profiles.conf and manjaro.conf manpages
This commit is contained in:
commit
39f4d4c2a5
4 changed files with 750 additions and 1 deletions
21
Makefile
21
Makefile
|
@ -80,7 +80,12 @@ EFISHELL = \
|
||||||
efi_shell/shellx64_v1.efi \
|
efi_shell/shellx64_v1.efi \
|
||||||
efi_shell/shellx64_v2.efi
|
efi_shell/shellx64_v2.efi
|
||||||
|
|
||||||
all: $(BINPROGS) #bin/bash_completion bin/zsh_completion
|
MAN_XML = \
|
||||||
|
buildiso.xml \
|
||||||
|
manjaro-tools.conf.xml \
|
||||||
|
profile.conf.xml
|
||||||
|
|
||||||
|
all: $(BINPROGS) doc #bin/bash_completion bin/zsh_completion
|
||||||
|
|
||||||
edit = sed -e "s|@pkgdatadir[@]|$(DESTDIR)$(PREFIX)/share/manjaro-tools|g" \
|
edit = sed -e "s|@pkgdatadir[@]|$(DESTDIR)$(PREFIX)/share/manjaro-tools|g" \
|
||||||
-e "s|@bindir[@]|$(DESTDIR)$(PREFIX)/bin|g" \
|
-e "s|@bindir[@]|$(DESTDIR)$(PREFIX)/bin|g" \
|
||||||
|
@ -95,8 +100,13 @@ edit = sed -e "s|@pkgdatadir[@]|$(DESTDIR)$(PREFIX)/share/manjaro-tools|g" \
|
||||||
@chmod a-w "$@"
|
@chmod a-w "$@"
|
||||||
@chmod +x "$@"
|
@chmod +x "$@"
|
||||||
|
|
||||||
|
doc:
|
||||||
|
mkdir -p man
|
||||||
|
$(foreach var,$(MAN_XML),xsltproc /usr/share/docbook2X/xslt/man/docbook.xsl docbook/$(var) | db2x_manxml --output-dir man ;)
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f $(BINPROGS) #bin/bash_completion bin/zsh_completion
|
rm -f $(BINPROGS) #bin/bash_completion bin/zsh_completion
|
||||||
|
rm -rf man
|
||||||
|
|
||||||
install:
|
install:
|
||||||
install -dm0755 $(DESTDIR)$(SYSCONFDIR)/manjaro-tools
|
install -dm0755 $(DESTDIR)$(SYSCONFDIR)/manjaro-tools
|
||||||
|
@ -120,6 +130,11 @@ install:
|
||||||
install -m0644 ${SCRIPTS} $(DESTDIR)$(PREFIX)/share/manjaro-tools/scripts
|
install -m0644 ${SCRIPTS} $(DESTDIR)$(PREFIX)/share/manjaro-tools/scripts
|
||||||
install -dm0755 $(DESTDIR)$(PREFIX)/share/manjaro-tools/efi_shell
|
install -dm0755 $(DESTDIR)$(PREFIX)/share/manjaro-tools/efi_shell
|
||||||
install -m0644 ${EFISHELL} $(DESTDIR)$(PREFIX)/share/manjaro-tools/efi_shell
|
install -m0644 ${EFISHELL} $(DESTDIR)$(PREFIX)/share/manjaro-tools/efi_shell
|
||||||
|
mkdir -p $(DESTDIR)$(PREFIX)/share/man/man1
|
||||||
|
gzip -c man/buildiso.1 > $(DESTDIR)$(PREFIX)/share/man/man1/buildiso.1.gz
|
||||||
|
mkdir -p $(DESTDIR)$(PREFIX)/share/man/man5
|
||||||
|
gzip -c man/manjaro-tools.conf.5 > $(DESTDIR)$(PREFIX)/share/man/man5/manjaro-tools.conf.5.gz
|
||||||
|
gzip -c man/profile.conf.5 > $(DESTDIR)$(PREFIX)/share/man/man5/profile.conf.5.gz
|
||||||
|
|
||||||
# install -Dm0644 bin/bash_completion $(DESTDIR)/$(PREFIX)/share/bash-completion/completions/manjaro_tools
|
# install -Dm0644 bin/bash_completion $(DESTDIR)/$(PREFIX)/share/bash-completion/completions/manjaro_tools
|
||||||
# install -Dm0644 bin/zsh_completion $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_manjaro_tools
|
# install -Dm0644 bin/zsh_completion $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_manjaro_tools
|
||||||
|
@ -136,6 +151,10 @@ uninstall:
|
||||||
for f in ${CPIOINST}; do rm -f $(DESTDIR)$(PREFIX)/lib/initcpio/install/$$f; done
|
for f in ${CPIOINST}; do rm -f $(DESTDIR)$(PREFIX)/lib/initcpio/install/$$f; done
|
||||||
for f in ${SCRIPTS}; do rm -f $(DESTDIR)$(PREFIX)/share/manjaro-tools/scripts/$$f; done
|
for f in ${SCRIPTS}; do rm -f $(DESTDIR)$(PREFIX)/share/manjaro-tools/scripts/$$f; done
|
||||||
for f in ${EFISHELL}; do rm -f $(DESTDIR)$(PREFIX)/share/manjaro-tools/efi_shell/$$f; done
|
for f in ${EFISHELL}; do rm -f $(DESTDIR)$(PREFIX)/share/manjaro-tools/efi_shell/$$f; done
|
||||||
|
rm -f $(DESTDIR)$(PREFIX)/share/man/man1/buildiso.1.gz
|
||||||
|
rm -f $(DESTDIR)$(PREFIX)/share/man/man1/manjaro-tools.conf.5.gz
|
||||||
|
rm -f $(DESTDIR)$(PREFIX)/share/man/man1/profiles.conf.5.gz
|
||||||
|
|
||||||
# rm $(DESTDIR)/$(PREFIX)/share/bash-completion/completions/manjaro_tools
|
# rm $(DESTDIR)/$(PREFIX)/share/bash-completion/completions/manjaro_tools
|
||||||
# rm $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_manjaro_tools
|
# rm $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_manjaro_tools
|
||||||
|
|
||||||
|
|
172
docbook/buildiso.xml
Normal file
172
docbook/buildiso.xml
Normal file
|
@ -0,0 +1,172 @@
|
||||||
|
<?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">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
This file is part of manjaro-tools.
|
||||||
|
|
||||||
|
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 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/>.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<refentry id="buildiso" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
|
|
||||||
|
<refentryinfo>
|
||||||
|
<title>buildiso-+</title>
|
||||||
|
<productname>manjaro-tools</productname>
|
||||||
|
|
||||||
|
<authorgroup>
|
||||||
|
<author>
|
||||||
|
<contrib></contrib>
|
||||||
|
<firstname></firstname>
|
||||||
|
<surname></surname>
|
||||||
|
<email></email>
|
||||||
|
</author>
|
||||||
|
</authorgroup>
|
||||||
|
</refentryinfo>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>buildiso</command>
|
||||||
|
<arg choice="opt" rep="repeat">OPTIONS</arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</refsynopsisdiv>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Options</title>
|
||||||
|
|
||||||
|
<para>The following options are understood:</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-p PROFILE...</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Name of the buildset or name of the directory
|
||||||
|
you will build. It needs to cantains a existing buildset or a
|
||||||
|
folder with a valid profile.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-b stable|testing|unstable</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Branch where the mirrors in the iso will point.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-r DIR</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Root working directory where the iso will be built.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-w</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Disable clean iso cache step.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-c</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Disable clean working directory step.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-x</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Disable cleaning the xorg packages cache. Xorg packages
|
||||||
|
are the packages listed in Packages-Xorg file within each profile and are
|
||||||
|
used for the
|
||||||
|
<citerefentry project='mhwd'><refentrytitle>mhwd</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-l</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Disable cleaning the language packages cache. Language
|
||||||
|
packages cache are listed in Packages-Lng and are used to bundle multiple
|
||||||
|
language packages with the iso.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-i</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Only build images, without creating an ISO file.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-s</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Generate iso from already created images, for example created with the -i option.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-q</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Query settings and pretend build.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-h</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Help.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
|
||||||
|
</refsect1>
|
||||||
|
<!--<refsect1>
|
||||||
|
<title>Exit status</title>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
</refentry>
|
||||||
|
|
307
docbook/manjaro-tools.conf.xml
Normal file
307
docbook/manjaro-tools.conf.xml
Normal file
|
@ -0,0 +1,307 @@
|
||||||
|
<?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">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
This file is part of manjaro-tools.
|
||||||
|
|
||||||
|
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 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/>.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<refentry id="profile.conf" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
|
|
||||||
|
<refentryinfo>
|
||||||
|
<title>profile.conf-+</title>
|
||||||
|
<productname>manjaro-tools</productname>
|
||||||
|
|
||||||
|
<authorgroup>
|
||||||
|
<author>
|
||||||
|
<contrib></contrib>
|
||||||
|
<firstname></firstname>
|
||||||
|
<surname></surname>
|
||||||
|
<email></email>
|
||||||
|
</author>
|
||||||
|
</authorgroup>
|
||||||
|
</refentryinfo>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<para><filename>manjaro-tools.conf</filename></para>
|
||||||
|
</refsynopsisdiv>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>General options for all tools</title>
|
||||||
|
|
||||||
|
<para>The following options are understood and used for various tools:</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>sets_dir=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Directory where buildpkg and buildiso will
|
||||||
|
search for sets. Default is "/etc/manjaro-tools/sets".
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Options for buildtree</title>
|
||||||
|
|
||||||
|
<para>The following options are understood:</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>repo_tree=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Manjaro package tree. Default is
|
||||||
|
"('core' 'extra' 'community' 'multilib' 'openrc')".
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>host_tree=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Host tree. Default is "https://github.com/manjaro".
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Options for buildpkg</title>
|
||||||
|
|
||||||
|
<para>The following options are understood:</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>buildset_pkg=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Default set for buildpkg without the .set
|
||||||
|
extension.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>build_mirror=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Default mirror to be used when building
|
||||||
|
packages.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>blacklist_trigger=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Only useful when compiling packages against
|
||||||
|
eudev. List of packages that will trigger a package blacklist
|
||||||
|
defined with "blacklist=" when creating a chroot. By default
|
||||||
|
they are "('eudev' 'upower-pm-utils' 'eudev-systemdcompat')"
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>blacklist=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>List of packages that will be blacklisted when
|
||||||
|
creating a chroot. This list is only triggered when compiling
|
||||||
|
a packages in the "blacklist_trigger=" option. By default
|
||||||
|
"('libsystemd')" is blacklisted.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Options for buildiso</title>
|
||||||
|
|
||||||
|
<para>The following options are understood:</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>buildset_iso=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Default set for buildiso without the .set
|
||||||
|
extension.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<!-- TODO: We should tell where exactly this is used -->
|
||||||
|
<term><varname>dist_version=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Version of the distributions. It defaults to
|
||||||
|
the current date "date +%Y.%m". Example: 15.04
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<!-- TODO: We should tell where exactly this is used -->
|
||||||
|
<term><varname>iso_name=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Name of the iso.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
</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>buildpkg</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
</refentry>
|
||||||
|
|
||||||
|
|
251
docbook/profile.conf.xml
Normal file
251
docbook/profile.conf.xml
Normal file
|
@ -0,0 +1,251 @@
|
||||||
|
<?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">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
This file is part of manjaro-tools.
|
||||||
|
|
||||||
|
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 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/>.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<refentry id="profile.conf" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
|
|
||||||
|
<refentryinfo>
|
||||||
|
<title>profile.conf-+</title>
|
||||||
|
<productname>manjaro-tools</productname>
|
||||||
|
|
||||||
|
<authorgroup>
|
||||||
|
<author>
|
||||||
|
<contrib></contrib>
|
||||||
|
<firstname></firstname>
|
||||||
|
<surname></surname>
|
||||||
|
<email></email>
|
||||||
|
</author>
|
||||||
|
</authorgroup>
|
||||||
|
</refentryinfo>
|
||||||
|
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>profile.conf</refentrytitle>
|
||||||
|
<manvolnum>5</manvolnum>
|
||||||
|
</refmeta>
|
||||||
|
|
||||||
|
<refnamediv>
|
||||||
|
<refname>profile.conf</refname>
|
||||||
|
<refpurpose>configuration file for the individual profiles </refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<para><filename>profile.conf</filename></para>
|
||||||
|
</refsynopsisdiv>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Options</title>
|
||||||
|
|
||||||
|
<para>The following options are understood:</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<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 start_systemd and
|
||||||
|
start_systemd_live or start_openrc and start_openrc_live to determine
|
||||||
|
the default services that will be enabled automatically.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>default_desktop_executable=</varname></term>
|
||||||
|
<term><varname>default_desktop_file=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Executable and desktop file used to set witch
|
||||||
|
desktop environment the display manager will run by default.
|
||||||
|
default_desktop_executable= defines a binary in /usr/bin and
|
||||||
|
default_desktop_file a .desktop file in /usr/share/xsessions,
|
||||||
|
skipping the .desktop part.
|
||||||
|
<screen>
|
||||||
|
default_desktop_executable=startxfce4
|
||||||
|
default_desktop_file=xfce
|
||||||
|
</screen>
|
||||||
|
If one or both values are not set or "none" (the default) buildiso
|
||||||
|
will try to autodetect the desktop environment.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
Incomplete list of possible values:
|
||||||
|
</para>
|
||||||
|
<screen>
|
||||||
|
Desktop Desktop executable Desktop file
|
||||||
|
--------------------------------------------------------
|
||||||
|
Budgie budgie-session budgie-session
|
||||||
|
Cinnamon cinnamon-session cinnamon-session
|
||||||
|
Enlightenment enlightenment_start enlightenment
|
||||||
|
Gnome gnome-session gnome
|
||||||
|
i3 i3 i3
|
||||||
|
KDE Plasma 4 startkde kde-plasma
|
||||||
|
KDE Plasma 5 startkde plasma
|
||||||
|
LXDE lxsession LXDE
|
||||||
|
LXDE startlxde LXDE
|
||||||
|
LXQt lxqt-session lxqt
|
||||||
|
Mate mate-session mate
|
||||||
|
Openbox openbox-session openbox
|
||||||
|
Pantheon pantheon-session pantheon
|
||||||
|
PekWM pekwm pekwm
|
||||||
|
Xfce startxfce4 xfce
|
||||||
|
</screen>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>efi_boot_loader=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Takes grub or gummibot. Configures
|
||||||
|
calamares to use that bootloader.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>efi_part_size=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Size in MiB of the fat partition where
|
||||||
|
the kernel is. This is useful if you add extra hooks
|
||||||
|
in the mkinitcpio.conf and it's to big to fit in the
|
||||||
|
partition. The default is "32M".
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>plymouth_theme=</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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>start_systemd=</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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>start_openrc=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Array of services that will be
|
||||||
|
enabled in openrc systems.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>hostname=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Hostname for the ISO.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>username=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Username of the default user
|
||||||
|
that will be created in the live-cd.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>password=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Password of the default user
|
||||||
|
that will be created in the live-cd.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>addgroups=</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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>start_systemd_live=</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>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><varname>start_openrc_live=</varname></term>
|
||||||
|
|
||||||
|
<listitem><para>Array of services that will be
|
||||||
|
enabled in the openrc live-cd.
|
||||||
|
</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>
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue