docs-commits July 2014

docs-commits@lists.fedoraproject.org

4 participants
107 discussions

[system-administrators-reference-guide] add verson to make it build
by stephenw 31 Jul '14

31 Jul '14

commit 0d1f99cf299fad61415f62ef73eb8621ea46cc84 Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Thu Jul 31 23:28:17 2014 +0200 add verson to make it build in publican.cfg publican.cfg | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-) --- diff --git a/publican.cfg b/publican.cfg index 5fbf36d..faade28 100644 --- a/publican.cfg +++ b/publican.cfg @@ -9,6 +9,8 @@ docname: "System Administrators Reference Guide" # Document Appearance: chunk_section_depth: 1 +version: 0.1 + # Debugging Options: show_remarks: 1

1 0

[system-administrators-reference-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit 31945f5bf8e6f709c0f41e75c54609478f65f542 Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Thu Jul 31 23:26:45 2014 +0200 Remove version numbers in doc directories https://bugzilla.redhat.com/show_bug.cgi?id=1065771#c0 thabk you Simon Clark en-US/The_sysconfig_Directory.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) --- diff --git a/en-US/The_sysconfig_Directory.xml b/en-US/The_sysconfig_Directory.xml index d24ffbe..7ac0ab4 100644 --- a/en-US/The_sysconfig_Directory.xml +++ b/en-US/The_sysconfig_Directory.xml @@ -1417,7 +1417,7 @@ <itemizedlist> <listitem> <para> - <filename>/usr/share/doc/initscripts-<replaceable>version</replaceable>/sysconfig.txt</filename> — A more authoritative listing of the files found in the <filename class="directory">/etc/sysconfig/</filename> directory and the configuration options available for them. + <filename>/usr/share/doc/initscripts/sysconfig.txt</filename> — A more authoritative listing of the files found in the <filename class="directory">/etc/sysconfig/</filename> directory and the configuration options available for them. </para> </listitem> </itemizedlist>

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit 7d27229f28e8719d91fc460f005d8fcc903b2ac7 Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Thu Jul 31 22:56:47 2014 +0200 Remove version numbers in doc directories in Viewing_and_Managing_Log_Files.xml https://bugzilla.redhat.com/show_bug.cgi?id=1065771#c0 en-US/Viewing_and_Managing_Log_Files.xml | 12 ++++++------ 1 files changed, 6 insertions(+), 6 deletions(-) --- diff --git a/en-US/Viewing_and_Managing_Log_Files.xml b/en-US/Viewing_and_Managing_Log_Files.xml index 37b3b98..0264b99 100644 --- a/en-US/Viewing_and_Managing_Log_Files.xml +++ b/en-US/Viewing_and_Managing_Log_Files.xml @@ -50,7 +50,7 @@ $MainMsgQueueSize 50000 You may define multiple directives in your <filename>/etc/rsyslog.conf</filename> configuration file. A directive affects the behavior of all configuration options until another occurrence of that same directive is detected. </para> <para> - A comprehensive list of all available configuration directives and their detailed description can be found in <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable>/rsyslog_conf_global.html</filename>. + A comprehensive list of all available configuration directives and their detailed description can be found in <filename>/usr/share/doc/rsyslog/rsyslog_conf_global.html</filename>. </para> </section> @@ -298,7 +298,7 @@ cron.!info,!debug # Selects all cron syslog messages except those with the <c <term>Expression-based filters</term> <listitem> <para> - Expression-based filters select syslog messages according to defined arithmetic, boolean or string operations. Expression-based filters use <application>rsyslog</application>'s own scripting language. The syntax of this language is defined in <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable>/rscript_abnf.html</filename> along with examples of various expression-based filters. + Expression-based filters select syslog messages according to defined arithmetic, boolean or string operations. Expression-based filters use <application>rsyslog</application>'s own scripting language. The syntax of this language is defined in <filename>/usr/share/doc/rsyslog/rscript_abnf.html</filename> along with examples of various expression-based filters. </para> <para> To define an expression-based filter, use the following syntax: @@ -545,7 +545,7 @@ $outchannel log_rotation,/var/log/test_log.log, 104857600, /home/joe/log_rotatio <important> <title>Using MySQL and PostgreSQL</title> <para> - Currently, <application>rsyslog</application> provides support for <systemitem class="systemname">MySQL</systemitem> (for more information, refer to <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable>/rsyslog_mysql.html</filename>) and <systemitem class="systemname">PostgreSQL</systemitem> databases only. + Currently, <application>rsyslog</application> provides support for <systemitem class="systemname">MySQL</systemitem> (for more information, refer to <filename>/usr/share/doc/rsyslog/rsyslog_mysql.html</filename>) and <systemitem class="systemname">PostgreSQL</systemitem> databases only. In order to use the <systemitem class="systemname">MySQL</systemitem> and <systemitem class="systemname">PostgreSQL</systemitem> database writer functionality, install the <package>rsyslog-mysql</package> and <package>rsyslog-pgsql</package> packages installed, respectively. Also, make sure you load the appropriate modules in your <filename>/etc/rsyslog.conf</filename> configuration file: </para> <screen> @@ -660,7 +660,7 @@ kern.=crit joe <itemizedlist> <listitem> <para> - The <replaceable><PROPERTY_NAME></replaceable> attribute specifies the name of a property. A comprehensible list of all available properties and their detailed description can be found in <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable>/property_replacer.html</filename> under the section <emphasis>Available Properties</emphasis>. + The <replaceable><PROPERTY_NAME></replaceable> attribute specifies the name of a property. A comprehensible list of all available properties and their detailed description can be found in <filename>/usr/share/doc/rsyslog/property_replacer.html</filename> under the section <emphasis>Available Properties</emphasis>. </para> </listitem> <listitem> @@ -670,7 +670,7 @@ kern.=crit joe </listitem> <listitem> <para> - The <replaceable><OPTION></replaceable> attribute specifies any property options. A comprehensible list of all available properties and their detailed description can be found in <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable>/property_replacer.html</filename> under the section <emphasis>Property Options</emphasis>. + The <replaceable><OPTION></replaceable> attribute specifies any property options. A comprehensible list of all available properties and their detailed description can be found in <filename>/usr/share/doc/rsyslog/property_replacer.html</filename> under the section <emphasis>Property Options</emphasis>. </para> </listitem> </itemizedlist> @@ -1158,7 +1158,7 @@ compress </listitem> <listitem> <para> - <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable>/ + <filename>/usr/share/doc/rsyslog/ </filename> — After installing the <package>rsyslog</package> package, this directory contains extensive documentation in the <systemitem class="protocol">html</systemitem> format.</para> </listitem> <listitem>

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit 508a839ab65682528b29c2b3166dc240297eb48d Author: Simon Clark <simon.richard.clark(a)gmail.com> Date: Tue Feb 11 21:13:22 2014 +0000 Remove version numbers in doc directories in The_kdump_Crash_Recovery_Service.xml Signed-off-by: Stephen Wadeley <swadeley(a)redhat.com> en-US/The_kdump_Crash_Recovery_Service.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) --- diff --git a/en-US/The_kdump_Crash_Recovery_Service.xml b/en-US/The_kdump_Crash_Recovery_Service.xml index 8b39cde..e8a7601 100644 --- a/en-US/The_kdump_Crash_Recovery_Service.xml +++ b/en-US/The_kdump_Crash_Recovery_Service.xml @@ -953,7 +953,7 @@ ROOT: / CWD: /root </listitem> <listitem> <para> - <filename>/usr/share/doc/kexec-tools-<replaceable>version</replaceable>/kexec-kdump-howto.txt</filename> — an overview of the <systemitem class="service">kdump</systemitem> and <application>kexec</application> installation and usage. + <filename>/usr/share/doc/kexec-tools/kexec-kdump-howto.txt</filename> — an overview of the <systemitem class="service">kdump</systemitem> and <application>kexec</application> installation and usage. </para> </listitem> </itemizedlist>

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit f449d7ffddfa5b5ee0cd58dc9e42c6c40f35fc6c Author: Simon Clark <simon.richard.clark(a)gmail.com> Date: Tue Feb 11 21:07:52 2014 +0000 Remove version numbers in doc directories https://bugzilla.redhat.com/show_bug.cgi?id=1065771#c0 in The_X_Window_System.xml Signed-off-by: Stephen Wadeley <swadeley(a)redhat.com> en-US/The_X_Window_System.xml | 8 +++----- 1 files changed, 3 insertions(+), 5 deletions(-) --- diff --git a/en-US/The_X_Window_System.xml b/en-US/The_X_Window_System.xml index 8cef913..c8d5411 100644 --- a/en-US/The_X_Window_System.xml +++ b/en-US/The_X_Window_System.xml @@ -1232,9 +1232,7 @@ EndSection</screen> <para>When booting into runlevel 5, the <command>/etc/X11/prefdm</command> script determines the preferred display manager by referencing the <filename>/etc/sysconfig/desktop</filename> file. A list of options for this file is available in this file:</para> - <screen><filename>/usr/share/doc/initscripts-<replaceable><version-number></replaceable>/sysconfig.txt</filename></screen> - - <para>where <replaceable><version-number></replaceable> is the version number of the <filename>initscripts</filename> package.</para> + <screen><filename>/usr/share/doc/initscripts/sysconfig.txt</filename></screen> <para>Each of the display managers reference the <filename>/etc/X11/xdm/Xsetup_0</filename> file to set up the login screen. Once the user logs into the system, the <filename>/etc/X11/xdm/GiveConsole</filename> script runs to assign ownership of the console to the user. Then, the <filename>/etc/X11/xdm/Xsession</filename> script runs to accomplish many of the tasks normally performed by the <command>xinitrc</command> script when starting X from runlevel 3, including setting system and user resources, as well as running the scripts in the <filename>/etc/X11/xinit/xinitrc.d/</filename> directory.</para> @@ -1244,7 +1242,7 @@ EndSection</screen> <para>The user is returned to the display manager after logging out of X from runlevel 5.</para> - <para>For more information on how display managers control user authentication, refer to the <filename>/usr/share/doc/gdm-<replaceable><version-number></replaceable>/README</filename> , where <replaceable><version-number></replaceable> is the version number for the <filename>gdm</filename> package installed, or the <command>xdm</command> man page.</para> + <para>For more information on how display managers control user authentication, refer to the <filename>/usr/share/doc/gdm/README</filename> , or the <command>xdm</command> man page.</para> </section> </section> @@ -1278,7 +1276,7 @@ EndSection</screen> </listitem> <listitem> - <para><filename>/usr/share/doc/gdm-<replaceable><version-number></replaceable>/README</filename> — contains information on how display managers control user authentication.</para> + <para><filename>/usr/share/doc/gdm/README</filename> — contains information on how display managers control user authentication.</para> </listitem> <listitem>

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit cc5ffad669f4b935d51dcca44b8fc6f2d76a485d Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Thu Jul 31 22:38:01 2014 +0200 Remove version numbers in doc directories in Samba.xml Thank you Simon Clark. https://bugzilla.redhat.com/show_bug.cgi?id=1065771#c0 en-US/Samba.xml | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) --- diff --git a/en-US/Samba.xml b/en-US/Samba.xml index c0879a2..debbdd7 100644 --- a/en-US/Samba.xml +++ b/en-US/Samba.xml @@ -1106,7 +1106,7 @@ security = share </term> <listitem> <para>The <command>ldapsam</command> back end provides an optimal distributed account installation method for Samba. LDAP is optimal because of its ability to replicate its database to any number of servers such as an <application>OpenLDAP Server</application>. LDAP databases are light-weight and scalable, and as such are preferred by large enterprises. For more information on LDAP, refer to <xref linkend="s1-OpenLDAP" />.</para> - <para>If you are upgrading from a previous version of Samba to 3.0, note that the OpenLDAP schema file (<filename>/usr/share/doc/samba-<replaceable>version</replaceable>/LDAP/samba.schema</filename>) has changed. These files contain the <firstterm>attribute syntax definitions</firstterm> and <firstterm>objectclass definitions</firstterm> that the <command>ldapsam</command> back end needs in order to function properly.</para> + <para>If you are upgrading from a previous version of Samba to 3.0, note that the OpenLDAP schema file (<filename>/usr/share/doc/samba/LDAP/samba.schema</filename>) has changed. These files contain the <firstterm>attribute syntax definitions</firstterm> and <firstterm>objectclass definitions</firstterm> that the <command>ldapsam</command> back end needs in order to function properly.</para> <para>As such, if you are using the <command>ldapsam</command> back end for your Samba server, you will need to configure <command>slapd</command> to include one of these schema file. See <xref linkend="s3-ldap-configuration-schema"/> for directions on how to do this.</para> <note> @@ -1757,7 +1757,7 @@ Press enter to see a dump of your service definitions </indexterm> <itemizedlist> <listitem> - <para><filename>/usr/share/doc/samba-<replaceable>version-number</replaceable>/</filename> — All additional files included with the Samba distribution. This includes all helper scripts, sample configuration files, and documentation. This directory also contains online versions of <citetitle>The Official Samba-3 HOWTO-Collection</citetitle> and <citetitle>Samba-3 by Example</citetitle>, both of which are cited below.</para> + <para><filename>/usr/share/doc/samba/</filename> — All additional files included with the Samba distribution. This includes all helper scripts, sample configuration files, and documentation. This directory also contains online versions of <citetitle>The Official Samba-3 HOWTO-Collection</citetitle> and <citetitle>Samba-3 by Example</citetitle>, both of which are cited below.</para> <note> <title>Make sure you have the samba-doc package installed</title> <para>In order to use the <application>Samba</application> documentation, first ensure the <package>samba-doc</package> package is installed on your system by running, as <systemitem class="username">root</systemitem>:</para>

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit 778ca45cf1c0a217e3caceeae8a33e2b824679aa Author: Simon Clark <simon.richard.clark(a)gmail.com> Date: Tue Feb 11 20:35:33 2014 +0000 Remove version numbers in doc directories in RPM.xml Change procps package name because Fedora now uses procps-ng fork of procps. Signed-off-by: Stephen Wadeley <swadeley(a)redhat.com> en-US/RPM.xml | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) --- diff --git a/en-US/RPM.xml b/en-US/RPM.xml index 20ef0b4..2984d61 100644 --- a/en-US/RPM.xml +++ b/en-US/RPM.xml @@ -656,10 +656,10 @@ ghostscript-8.70-1.&PKGOS;.x86_64</screen> <command>rpm -qdf /usr/bin/free</command> </screen> <para>The output would be similar to the following:</para> - <screen>/usr/share/doc/procps-3.2.8/BUGS -/usr/share/doc/procps-3.2.8/FAQ -/usr/share/doc/procps-3.2.8/NEWS -/usr/share/doc/procps-3.2.8/TODO + <screen>/usr/share/doc/procps-ng/BUGS +/usr/share/doc/procps-ng/FAQ +/usr/share/doc/procps-ng/NEWS +/usr/share/doc/procps-ng/TODO /usr/share/man/man1/free.1.gz /usr/share/man/man1/pgrep.1.gz /usr/share/man/man1/pkill.1.gz

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit 0b9cc7c534f023daf67db12118c1959a18c88697 Author: Simon Clark <simon.richard.clark(a)gmail.com> Date: Sat Feb 8 22:02:33 2014 +0000 Remove version numbers in doc directories in OpenLDAP.xml Signed-off-by: Stephen Wadeley <swadeley(a)redhat.com> en-US/OpenLDAP.xml | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-) --- diff --git a/en-US/OpenLDAP.xml b/en-US/OpenLDAP.xml index 942dcb3..475821e 100644 --- a/en-US/OpenLDAP.xml +++ b/en-US/OpenLDAP.xml @@ -1264,7 +1264,7 @@ $DEFAULT_BASE = "dc=example,dc=com";</programlisting> </tgroup> </table> <para> - For more information on how to use these scripts, refer to the <filename>README</filename> and the <filename>migration-tools.txt</filename> files in the <filename>/usr/share/doc/migrationtools-<replaceable>version</replaceable>/</filename> directory. + For more information on how to use these scripts, refer to the <filename>README</filename> and the <filename>migration-tools.txt</filename> files in the <filename>/usr/share/doc/migrationtools/</filename> directory. </para> </section> </section> @@ -1280,7 +1280,7 @@ $DEFAULT_BASE = "dc=example,dc=com";</programlisting> </para> <variablelist> <varlistentry> - <term><filename>/usr/share/doc/openldap-servers-<replaceable>version</replaceable>/guide.html</filename></term> + <term><filename>/usr/share/doc/openldap-servers/guide.html</filename></term> <listitem> <para> A copy of the <citetitle pubwork="book">OpenLDAP Software Administrator's Guide</citetitle>. @@ -1288,7 +1288,7 @@ $DEFAULT_BASE = "dc=example,dc=com";</programlisting> </listitem> </varlistentry> <varlistentry> - <term><filename>/usr/share/doc/openldap-servers-<replaceable>version</replaceable>/README.schema</filename></term> + <term><filename>/usr/share/doc/openldap-servers/README.schema</filename></term> <listitem> <para> A README file containing the description of installed schema files.

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit 7f4d0a8828b8ce87cc8895a59006a9ede307fe00 Author: Simon Clark <simon.richard.clark(a)gmail.com> Date: Sat Feb 8 21:51:35 2014 +0000 Remove version numbers in doc directories in OProfile.xml Signed-off-by: Stephen Wadeley <swadeley(a)redhat.com> en-US/OProfile.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) --- diff --git a/en-US/OProfile.xml b/en-US/OProfile.xml index 5e293ed..dd9f724 100644 --- a/en-US/OProfile.xml +++ b/en-US/OProfile.xml @@ -1220,7 +1220,7 @@ samples % symbol name <itemizedlist> <listitem> <para> - <filename>/usr/share/doc/oprofile-<replaceable>version</replaceable>/oprofile.html</filename> — <citetitle>OProfile Manual</citetitle> + <filename>/usr/share/doc/oprofile/oprofile.html</filename> — <citetitle>OProfile Manual</citetitle> </para> </listitem> <listitem>

1 0

[system-administrators-guide] Remove version numbers in doc directories
by stephenw 31 Jul '14

31 Jul '14

commit 556f174b18543130ae62e318adb57429e8e7cdcf Author: Simon Clark <simon.richard.clark(a)gmail.com> Date: Sat Feb 8 11:37:01 2014 +0000 Remove version numbers in doc directories in Mail_Servers.xml Signed-off-by: Stephen Wadeley <swadeley(a)redhat.com> en-US/Mail_Servers.xml | 14 +++++--------- 1 files changed, 5 insertions(+), 9 deletions(-) --- diff --git a/en-US/Mail_Servers.xml b/en-US/Mail_Servers.xml index 23406f6..9fc855e 100644 --- a/en-US/Mail_Servers.xml +++ b/en-US/Mail_Servers.xml @@ -1382,8 +1382,7 @@ connect = 110 accept = 993 connect = 143</programlisting> <para>Once you start <command>stunnel</command> with the created configuration file using the <command>/usr/bin/stunnel /etc/stunnel/mail.conf</command> command, it will be possible to use an <systemitem class="protocol">IMAP</systemitem> or a <systemitem class="protocol">POP</systemitem> email client and connect to the email server using SSL encryption.</para> - <para>For more information on <command>stunnel</command>, refer to the <command>stunnel</command> man page or the documents in the <filename>/usr/share/doc/stunnel-<replaceable>version-number</replaceable> - </filename>/ directory, where <replaceable>version-number</replaceable> is the version number of <command>stunnel</command>.</para> + <para>For more information on <command>stunnel</command>, refer to the <command>stunnel</command> man page or the documents in the <filename>/usr/share/doc/stunnel/</filename> directory.</para> </section> </section> </section> @@ -1433,18 +1432,15 @@ connect = 143</programlisting> </listitem> <listitem> <para> - <filename>/usr/share/doc/postfix-<replaceable>version-number</replaceable> - </filename> — Contains a large amount of information about ways to configure Postfix. Replace <replaceable>version-number</replaceable> with the version number of Postfix.</para> + <filename>/usr/share/doc/postfix/</filename> — Contains a large amount of information about ways to configure Postfix.</para> </listitem> <listitem> <para> - <filename>/usr/share/doc/fetchmail-<replaceable>version-number</replaceable> - </filename> — Contains a full list of Fetchmail features in the <filename>FEATURES</filename> file and an introductory <filename>FAQ</filename> document. Replace <replaceable>version-number</replaceable> with the version number of Fetchmail.</para> + <filename>/usr/share/doc/fetchmail/</filename> — Contains a full list of Fetchmail features in the <filename>FEATURES</filename> file and an introductory <filename>FAQ</filename> document.</para> </listitem> <listitem> <para> - <filename>/usr/share/doc/procmail-<replaceable>version-number</replaceable> - </filename> — Contains a <filename>README</filename> file that provides an overview of Procmail, a <filename>FEATURES</filename> file that explores every program feature, and an <filename>FAQ</filename> file with answers to many common configuration questions. Replace <replaceable>version-number</replaceable> with the version number of Procmail.</para> + <filename>/usr/share/doc/procmail/</filename> — Contains a <filename>README</filename> file that provides an overview of Procmail, a <filename>FEATURES</filename> file that explores every program feature, and an <filename>FAQ</filename> file with answers to many common configuration questions.</para> <para>When learning how Procmail works and creating new recipes, the following Procmail man pages are invaluable:</para> <itemizedlist> <listitem> @@ -1465,7 +1461,7 @@ connect = 143</programlisting> </listitem> <listitem> <para> - <filename>/usr/share/doc/spamassassin-<replaceable>version-number</replaceable>/</filename> — Contains a large amount of information pertaining to SpamAssassin. Replace <replaceable>version-number</replaceable> with the version number of the <filename>spamassassin</filename> package.</para> + <filename>/usr/share/doc/spamassassin/</filename> — Contains a large amount of information pertaining to SpamAssassin.</para> </listitem> </itemizedlist> </listitem>

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

docs-commits July 2014