man: add various filenames to the index
Everything which is an absolute filename marked with <filename></filename> lands in the index, unless noindex= attribute is present. Should make it easier for people to find stuff when they are looking at a file on disk. Various formatting errors in manpages are fixed, kernel-install(1) is restored to formatting sanity.
This commit is contained in:
parent
202288be83
commit
845c53246f
|
@ -193,16 +193,25 @@ def _extract_directives(directive_groups, formatting, page):
|
||||||
formatting[text] = name
|
formatting[text] = name
|
||||||
|
|
||||||
storfile = directive_groups['filenames']
|
storfile = directive_groups['filenames']
|
||||||
for xpath in ('.//refsynopsisdiv//filename',
|
for xpath, absolute_only in (('.//refsynopsisdiv//filename', False),
|
||||||
'.//refsynopsisdiv//command'):
|
('.//refsynopsisdiv//command', False),
|
||||||
|
('.//filename', True)):
|
||||||
for name in t.iterfind(xpath):
|
for name in t.iterfind(xpath):
|
||||||
|
if absolute_only and not (name.text and name.text.startswith('/')):
|
||||||
|
continue
|
||||||
|
if name.attrib.get('noindex'):
|
||||||
|
continue
|
||||||
name.tail = ''
|
name.tail = ''
|
||||||
if name.text:
|
if name.text:
|
||||||
|
if name.text.endswith('*'):
|
||||||
|
name.text = name.text[:-1]
|
||||||
if not name.text.startswith('.'):
|
if not name.text.startswith('.'):
|
||||||
text = name.text.partition(' ')[0]
|
text = name.text.partition(' ')[0]
|
||||||
if text != name.text:
|
if text != name.text:
|
||||||
name.clear()
|
name.clear()
|
||||||
name.text = text
|
name.text = text
|
||||||
|
if text.endswith('/'):
|
||||||
|
text = text[:-1]
|
||||||
storfile[text].append((pagename, section))
|
storfile[text].append((pagename, section))
|
||||||
if text not in formatting:
|
if text not in formatting:
|
||||||
# use element as formatted display
|
# use element as formatted display
|
||||||
|
|
|
@ -652,7 +652,7 @@
|
||||||
|
|
||||||
<programlisting>journalctl /usr/bin/dbus-daemon</programlisting>
|
<programlisting>journalctl /usr/bin/dbus-daemon</programlisting>
|
||||||
|
|
||||||
<para>Show all logs of the kernel device node <filename>/dev/sda</filename>:</para>
|
<para>Show all logs of the kernel device node <filename noindex='true'>/dev/sda</filename>:</para>
|
||||||
|
|
||||||
<programlisting>journalctl /dev/sda</programlisting>
|
<programlisting>journalctl /dev/sda</programlisting>
|
||||||
|
|
||||||
|
|
|
@ -49,7 +49,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
<refsynopsisdiv>
|
<refsynopsisdiv>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>kernel-install</command> <arg choice="req">COMMAND</arg> <arg choice="req">KERNEL VERSION</arg> <arg choice="req">KERNEL IMAGE</arg>
|
<command>kernel-install</command>
|
||||||
|
<arg choice="plain">COMMAND</arg>
|
||||||
|
<arg choice="plain"><replaceable>KERNEL-VERSION</replaceable></arg>
|
||||||
|
<arg choice="opt"><replaceable>KERNEL-IMAGE</replaceable></arg>
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
</refsynopsisdiv>
|
</refsynopsisdiv>
|
||||||
|
|
||||||
|
@ -60,9 +63,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||||
initramfs images to and from <filename>/boot</filename>.
|
initramfs images to and from <filename>/boot</filename>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>kernel-install will execute the files located in the directory <filename>/usr/lib/kernel/install.d/</filename>
|
<para><command>kernel-install</command> will execute the files
|
||||||
|
located in the directory <filename>/usr/lib/kernel/install.d/</filename>
|
||||||
and the local administration directory <filename>/etc/kernel/install.d/</filename>.
|
and the local administration directory <filename>/etc/kernel/install.d/</filename>.
|
||||||
All files are collectively sorted and executed in lexical order, regardless of the directories in
|
All files are collectively sorted and executed in lexical order, regardless of the directory in
|
||||||
which they live. However, files with identical file names replace each other.
|
which they live. However, files with identical file names replace each other.
|
||||||
Files in <filename>/etc/kernel/install.d/</filename> take precedence over files with the same name
|
Files in <filename>/etc/kernel/install.d/</filename> take precedence over files with the same name
|
||||||
in <filename>/usr/lib/kernel/install.d/</filename>. This can be used to override a system-supplied
|
in <filename>/usr/lib/kernel/install.d/</filename>. This can be used to override a system-supplied
|
||||||
|
@ -78,29 +82,44 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||||
<para>The following commands are understood:</para>
|
<para>The following commands are understood:</para>
|
||||||
<variablelist>
|
<variablelist>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term>add <KERNEL VERSION> <KERNEL IMAGE></term>
|
<term><command>add <replaceable>KERNEL-VERSION</replaceable> <replaceable>KERNEL-IMAGE</replaceable></command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename>
|
<para>calls every executable
|
||||||
and <filename>/etc/kernel/install.d/*.install</filename> with the arguments
|
<filename>/usr/lib/kernel/install.d/*.install</filename> and
|
||||||
"add <KERNEL VERSION> <filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/</filename>"</para>
|
<filename>/etc/kernel/install.d/*.install</filename> with
|
||||||
|
the arguments
|
||||||
|
<programlisting>
|
||||||
|
add <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename>
|
||||||
|
</programlisting>
|
||||||
|
</para>
|
||||||
|
|
||||||
<para>kernel-install copies <KERNEL IMAGE> to
|
<para><command>kernel-install</command> copies
|
||||||
<filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/linux</filename>.</para>
|
<replaceable>KERNEL-IMAGE</replaceable> to
|
||||||
|
<filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/linux</filename>.
|
||||||
|
</para>
|
||||||
|
|
||||||
<para>kernel-install also creates a boot loader entry according to the boot loader specification
|
<para><command>kernel-install</command> also creates a boot
|
||||||
in <filename>/boot/loader/entries/<MACHINE-ID>-<KERNEL VERSION>.conf</filename>.
|
loader entry according to the boot loader specification in
|
||||||
If the file <filename>initrd</filename> is found next to the <filename>linux</filename> file,
|
<filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.
|
||||||
the initrd will be added to the configuration.</para>
|
If the file <filename>initrd</filename> is found next to the
|
||||||
|
<filename>linux</filename> file, the initrd will be added to
|
||||||
|
the configuration.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term>remove <KERNEL VERSION> <KERNEL IMAGE></term>
|
<term><command>remove</command> <replaceable>KERNEL-VERSION</replaceable> <replaceable>KERNEL-IMAGE</replaceable></term>
|
||||||
<listitem><para>calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename>
|
<listitem>
|
||||||
and <filename>/etc/kernel/install.d/*.install</filename> with the arguments:
|
<para>calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename>
|
||||||
"remove <KERNEL VERSION> <filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/</filename>"
|
and <filename>/etc/kernel/install.d/*.install</filename> with the arguments
|
||||||
|
<programlisting>
|
||||||
|
remove <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename>
|
||||||
|
</programlisting>
|
||||||
</para>
|
</para>
|
||||||
<para>kernel-install removes the entire directory <filename>/boot/<MACHINE-ID>/<KERNEL VERSION>/</filename>
|
|
||||||
and the file <filename>/boot/loader/entries/<MACHINE-ID>-<KERNEL VERSION>.conf</filename></para>
|
<para><command>kernel-install</command> removes the entire directory
|
||||||
|
<filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename>
|
||||||
|
and the file
|
||||||
|
<filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename></para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
|
@ -140,7 +159,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||||
<filename>/etc/machine-id</filename>
|
<filename>/etc/machine-id</filename>
|
||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>The content of the file specifies the machine identification <MACHINE-ID>.</para>
|
<para>The content of the file specifies the machine identification <replaceable>MACHINE-ID</replaceable>.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
|
@ -148,7 +167,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||||
<filename>/etc/os-release</filename>
|
<filename>/etc/os-release</filename>
|
||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>The content of the file specifies the operating system id <OS-ID>.</para>
|
<para>The content of the file specifies the operating system id <replaceable>OS-ID</replaceable>.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
|
|
|
@ -129,7 +129,7 @@
|
||||||
<example>
|
<example>
|
||||||
<title>German locale with English messages</title>
|
<title>German locale with English messages</title>
|
||||||
|
|
||||||
<para><filename>/etc/locale.conf:</filename></para>
|
<para><filename>/etc/locale.conf</filename>:</para>
|
||||||
|
|
||||||
<programlisting>LANG=de_DE.UTF-8
|
<programlisting>LANG=de_DE.UTF-8
|
||||||
LC_MESSAGES=C</programlisting>
|
LC_MESSAGES=C</programlisting>
|
||||||
|
|
|
@ -168,7 +168,7 @@
|
||||||
<example>
|
<example>
|
||||||
<title>Invoke a program</title>
|
<title>Invoke a program</title>
|
||||||
|
|
||||||
<para>This calls <filename>/bin/ls</filename>
|
<para>This calls <filename noindex='true'>/bin/ls</filename>
|
||||||
with STDOUT/STDERR connected to the
|
with STDOUT/STDERR connected to the
|
||||||
journal:</para>
|
journal:</para>
|
||||||
|
|
||||||
|
|
|
@ -360,7 +360,7 @@
|
||||||
# systemd-nspawn -bD /srv/mycontainer</programlisting>
|
# systemd-nspawn -bD /srv/mycontainer</programlisting>
|
||||||
|
|
||||||
<para>This installs a minimal Fedora distribution into
|
<para>This installs a minimal Fedora distribution into
|
||||||
the directory <filename>/srv/mycontainer/</filename> and
|
the directory <filename noindex='true'>/srv/mycontainer/</filename> and
|
||||||
then boots an OS in a namespace container in
|
then boots an OS in a namespace container in
|
||||||
it.</para>
|
it.</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
|
@ -70,7 +70,7 @@
|
||||||
<filename>/usr</filename> and the virtual kernel API
|
<filename>/usr</filename> and the virtual kernel API
|
||||||
file systems such as <filename>/proc</filename>,
|
file systems such as <filename>/proc</filename>,
|
||||||
<filename>/sys</filename> or
|
<filename>/sys</filename> or
|
||||||
<filename>/dev/</filename>. This service executes no
|
<filename>/dev</filename>. This service executes no
|
||||||
operation if <filename>/etc/fstab</filename> does not
|
operation if <filename>/etc/fstab</filename> does not
|
||||||
exist or lists no entries for the mentioned file
|
exist or lists no entries for the mentioned file
|
||||||
systems.</para>
|
systems.</para>
|
||||||
|
|
|
@ -70,7 +70,7 @@
|
||||||
|
|
||||||
<para>Automount units must be named after the
|
<para>Automount units must be named after the
|
||||||
automount directories they control. Example: the
|
automount directories they control. Example: the
|
||||||
automount point <filename>/home/lennart</filename>
|
automount point <filename noindex='true'>/home/lennart</filename>
|
||||||
must be configured in a unit file
|
must be configured in a unit file
|
||||||
<filename>home-lennart.automount</filename>. For
|
<filename>home-lennart.automount</filename>. For
|
||||||
details about the escaping logic used to convert a
|
details about the escaping logic used to convert a
|
||||||
|
|
|
@ -80,7 +80,7 @@
|
||||||
<para>Device units are named after the
|
<para>Device units are named after the
|
||||||
<filename>/sys</filename> and
|
<filename>/sys</filename> and
|
||||||
<filename>/dev</filename> paths they control. Example:
|
<filename>/dev</filename> paths they control. Example:
|
||||||
the device <filename>/dev/sda5</filename> is exposed
|
the device <filename noindex='true'>/dev/sda5</filename> is exposed
|
||||||
in systemd as <filename>dev-sda5.device</filename>. For
|
in systemd as <filename>dev-sda5.device</filename>. For
|
||||||
details about the escaping logic used to convert a
|
details about the escaping logic used to convert a
|
||||||
file system path to a unit name see
|
file system path to a unit name see
|
||||||
|
|
|
@ -799,10 +799,10 @@
|
||||||
space-separated list of cgroup
|
space-separated list of cgroup
|
||||||
identifiers. A cgroup identifier is
|
identifiers. A cgroup identifier is
|
||||||
formatted like
|
formatted like
|
||||||
<filename>cpu:/foo/bar</filename>,
|
<filename noindex='true'>cpu:/foo/bar</filename>,
|
||||||
where "cpu" indicates the kernel
|
where "cpu" indicates the kernel
|
||||||
control group controller used, and
|
control group controller used, and
|
||||||
<filename>/foo/bar</filename> is the
|
<filename noindex='true'>/foo/bar</filename> is the
|
||||||
control group path. The controller
|
control group path. The controller
|
||||||
name and ":" may be omitted in which
|
name and ":" may be omitted in which
|
||||||
case the named systemd control group
|
case the named systemd control group
|
||||||
|
|
|
@ -86,7 +86,7 @@
|
||||||
|
|
||||||
<para>Mount units must be named after the mount point
|
<para>Mount units must be named after the mount point
|
||||||
directories they control. Example: the mount point
|
directories they control. Example: the mount point
|
||||||
<filename>/home/lennart</filename> must be configured
|
<filename noindex='true'>/home/lennart</filename> must be configured
|
||||||
in a unit file
|
in a unit file
|
||||||
<filename>home-lennart.mount</filename>. For details
|
<filename>home-lennart.mount</filename>. For details
|
||||||
about the escaping logic used to convert a file system
|
about the escaping logic used to convert a file system
|
||||||
|
|
|
@ -79,7 +79,7 @@
|
||||||
|
|
||||||
<para>Swap units must be named after the devices
|
<para>Swap units must be named after the devices
|
||||||
or files they control. Example: the swap device
|
or files they control. Example: the swap device
|
||||||
<filename>/dev/sda5</filename> must be configured in a
|
<filename noindex='true'>/dev/sda5</filename> must be configured in a
|
||||||
unit file <filename>dev-sda5.swap</filename>. For
|
unit file <filename>dev-sda5.swap</filename>. For
|
||||||
details about the escaping logic used to convert a
|
details about the escaping logic used to convert a
|
||||||
file system path to a unit name see
|
file system path to a unit name see
|
||||||
|
|
|
@ -197,7 +197,7 @@
|
||||||
<para>Some unit names reflect paths existing in the
|
<para>Some unit names reflect paths existing in the
|
||||||
file system name space. Example: a device unit
|
file system name space. Example: a device unit
|
||||||
<filename>dev-sda.device</filename> refers to a device
|
<filename>dev-sda.device</filename> refers to a device
|
||||||
with the device node <filename>/dev/sda</filename> in
|
with the device node <filename noindex='true'>/dev/sda</filename> in
|
||||||
the file system namespace. If this applies a special
|
the file system namespace. If this applies a special
|
||||||
way to escape the path name is used, so that the
|
way to escape the path name is used, so that the
|
||||||
result is usable as part of a file name. Basically,
|
result is usable as part of a file name. Basically,
|
||||||
|
|
|
@ -124,7 +124,7 @@
|
||||||
<example>
|
<example>
|
||||||
<title>German keyboard and console</title>
|
<title>German keyboard and console</title>
|
||||||
|
|
||||||
<para><filename>/etc/vconsole.conf:</filename></para>
|
<para><filename>/etc/vconsole.conf</filename>:</para>
|
||||||
|
|
||||||
<programlisting>KEYMAP=de-latin1
|
<programlisting>KEYMAP=de-latin1
|
||||||
FONT=latarcyrheb-sun16</programlisting>
|
FONT=latarcyrheb-sun16</programlisting>
|
||||||
|
|
Loading…
Reference in a new issue