August 2014 - docs-commits - Fedora Mailing-Lists

[documentation-guide] Fix formatting, add section id's.

by rkratky

commit 9d22d58cce615de19226c92d14c51183cc8e6995 Author: Robert Krátký <rkratky(a)redhat.com> Date: Fri Aug 8 16:00:09 2014 +0200 Fix formatting, add section id's. en-US/docbook.xml | 255 ++++++++++++++++++++++------------------------------- 1 files changed, 106 insertions(+), 149 deletions(-) --- diff --git a/en-US/docbook.xml b/en-US/docbook.xml index 2d675c5..8bc4d72 100644 --- a/en-US/docbook.xml +++ b/en-US/docbook.xml @@ -5,155 +5,112 @@ ]> <chapter id="chap-documentation_guide-docbook"> - <title>Brief Introduction to DocBook</title> - <para> - This chapter will give you a brief introduction to DocBook. - </para> - <section> - <title>Why DocBook?</title> - <para> - DocBook has many features which make it suitable for - documentation in Fedora and other projects. - </para> - <section> - <title>DocBook as an XML Markup Language</title> - <para> - DocBook is an implementation of - <firstterm>Extensible Markup Language (XML) - </firstterm>. XML gives DocBook powerful - flexibility. - </para> - </section> - <section> - <title>Human-readable Tags</title> - <para> - DocBook tags are generally self-explaining. - They are named after what they define, even - though shorter terms might make more effiecient - use of space. This makes it easy for writers - and editors to quickly look at a document and - understand how it is constructed. - </para> - </section> - <section> - <title>Text-based Format for Easy Revision Control</title> - <para> - Version control provides two critical features - for collaborative documentation work: - concurrent editing and history. The text-based - format of DocBook makes it well-suited to - being managed by a version control system. - </para> - </section> - <section> - <title>Separation Between Content and Style</title> - <para> - The DocBook standard separates a document's - content and its formatting. The writer uses XML - tags to structure the elements of document, and - the formatting can be changed independently - later. A change to the formatting of an element - does not require changing every instance of that - element. - </para> - </section> - <section> - <title>Output in a Variety of Formats</title> - <para> - DocBook is a source format. The - <command>publican</command> tool is used to - generate rendered documents in several different - formats. publican can generate HTML, PDF, and - epub formats from the same source file. - </para> - </section> - </section> - <section> - <title>Parts of a DocBook File</title> - <section> - <title>Entities</title> - <para> - Entities are like variables. They allow - for one change to be reflected many - times in a document. Entities are - usually defined early in the document - using the following syntax: -<screen><!ENTITY ENTITYNAME "value"></screen> - Entities are then referred to in the - document source with - <literal>&</literal><replaceable>ENTITYNAME</replaceable><literal>;</literal>. The - most common use of entities are for - phrases like the current version of a - product or the product name. - </para> - <warning> - <title>Use entities sparingly</title> - <para> - Entities do not appear in the - PO files for a document, and are - therefore untranslateable. Only - use an entity for wording that - does not require translation - ("Fedora", for example) - </para> - </warning> - </section> - </section> - - - - <section> - <title>Dividing a Document into Multiple Files with XIncludes</title> - <para> - As a document grows, managing it as a single file - becomes challenging. In addition, having multiple files - compose a single document allows for some files to be - reused between documents, reducing the overhead for a - large documenatation package. Fortunately, DocBook - supports including multiple file. To include an - additional file into a document, refer to the following - example: -<screen><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="<replaceable>Included_File.xml</replaceable>" /></screen> - When the document is rendered, the included text will - appear as if it were inserted entirely in the main file. - </para> - </section> - + <title>Brief Introduction to DocBook</title> + <para> + This chapter will give you a brief introduction to DocBook. + </para> + <section id="sec-Why_DocBook"> + <title>Why DocBook?</title> + <para> + DocBook has many features which make it suitable for documentation in Fedora and other projects. + </para> + <section id="sec-DocBook_as_an_XML_Markup_Language"> + <title>DocBook as an XML Markup Language</title> + <para> + DocBook is an implementation of <firstterm>Extensible Markup Language (XML) </firstterm>. XML gives DocBook powerful flexibility. + </para> + </section> + <section id="sec-Human-readable_Tags"> + <title>Human-readable Tags</title> + <para> + DocBook tags are generally self-explaining. They are named after what they define, even though shorter terms might make more effiecient use of space. This makes it easy for writers and editors to quickly look at a document and understand how it is constructed. + </para> + </section> + <section id="sec-Text-based_Format_for_Easy_Revision_Control"> + <title>Text-based Format for Easy Revision Control</title> + <para> + Version control provides two critical features for collaborative documentation work: concurrent editing and history. The text-based format of DocBook makes it well-suited to being managed by a version control system. + </para> + </section> + <section id="sec-Separation_Between_Content_and_Style"> + <title>Separation Between Content and Style</title> + <para> + The DocBook standard separates a document's content and its formatting. The writer uses XML tags to structure the elements of document, and the formatting can be changed independently later. A change to the formatting of an element does not require changing every instance of that element. + </para> + </section> + <section id="sec-Output_in_a_Variety_of_Formats"> + <title>Output in a Variety of Formats</title> + <para> + DocBook is a source format. The <command>publican</command> tool is used to generate rendered documents in several different formats. publican can generate HTML, PDF, and epub formats from the same source file. + </para> + </section> + </section> + <section id="sec-Parts_of_a_DocBook_File"> + <title>Parts of a DocBook File</title> + <section id="sec-Entities"> + <title>Entities</title> + <para> + Entities are like variables. They allow for one change to be reflected many times in a document. Entities are usually defined early in the document using the following syntax: + </para> + <screen><!ENTITY ENTITYNAME "value"></screen> + <para> + Entities are then referred to in the document source with <literal>&</literal><replaceable>ENTITYNAME</replaceable><literal>;</literal>. The most common use of entities are for phrases like the current version of a product or the product name. + </para> + <warning> + <para> + Entities do not appear in the PO files for a document, and are therefore untranslateable. Only use an entity for wording that does not require translation ("Fedora", for example) + </para> + </warning> + </section> + </section> + + + + <section id="sec-Dividing_a_Document_into_Multiple_Files_with_XIncludes"> + <title>Dividing a Document into Multiple Files with XIncludes</title> + <para> + As a document grows, managing it as a single file becomes challenging. In addition, having multiple files compose a single document allows for some files to be reused between documents, reducing the overhead for a large documenatation package. Fortunately, DocBook supports including multiple file. To include an additional file into a document, refer to the following example: + </para> + <screen><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="<replaceable>Included_File.xml</replaceable>" /></screen> + <para> + When the document is rendered, the included text will appear as if it were inserted entirely in the main file. + </para> + </section> </chapter> <!--

9 years, 10 months

1
0
0 / 0

[documentation-guide] Fix a couple of typos.

by rkratky

commit 6491b1821875d9accd8c348df70bf856541c3faa Author: Robert Krátký <rkratky(a)redhat.com> Date: Fri Aug 8 15:44:44 2014 +0200 Fix a couple of typos. en-US/community.xml | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) --- diff --git a/en-US/community.xml b/en-US/community.xml index 0931a03..36b4ed3 100644 --- a/en-US/community.xml +++ b/en-US/community.xml @@ -11,7 +11,7 @@ <section id="community-getting_started"> <title>Getting Started</title> <para> - The variety of tools and topics covered by Fedora Docs can make joining an intimidating process. <emphasis>Don't get discouraged!</emphasis> Experienced conributors might be doing in depth work, but participation doesn't have to be detailed. + The variety of tools and topics covered by Fedora Docs can make joining an intimidating process. <emphasis>Don't get discouraged!</emphasis> Experienced conributors might be doing in-depth work, but participation doesn't have to be detailed. </para> <para> We welcome as much time as you would like to contribute, but you don't need to invest a large amount of time to help. Producing quality documention is more than just writing. The work needs to be proofread, periodically checked to see if updates are required, reviewed for technical accuracy, and marked up. Once the documentation is written, it is translated, converted to other formats, and published. @@ -27,7 +27,7 @@ <listitem> <formalpara><title>Proofreading</title> <para> - Proofreading is a task that can be be done by almost anyone. We strong encourage feedback from readers, as this helps the authors identify confusing or inaccurate content. Reporting content that you have trouble understanding or instructions that don't work as expected helps writers improve their work. + Proofreading is a task that can be be done by almost anyone. We strongly encourage feedback from readers, as this helps the authors identify confusing or inaccurate content. Reporting content that you have trouble understanding or instructions that don't work as expected helps writers improve their work. </para> </formalpara> </listitem>

9 years, 10 months

1
0
0 / 0

[docs-beginner] master: Update the "Why Docbook" section (5b18600)

by Jared K. Smith

Repository : http://git.fedorahosted.org/cgit/docs-beginner.git On branch : master >--------------------------------------------------------------- commit 5b186000d31eecd90de83f2598d99e2f72d038ed Author: Jared K. Smith <jaredsmith(a)jaredsmith.net> Date: Fri Aug 8 10:15:36 2014 -0400 Update the "Why Docbook" section >--------------------------------------------------------------- en-US/Documentation_for_Beginners.xml | 3 ++- en-US/{why_docbook.xml => Why_DocBook.xml} | 0 2 files changed, 2 insertions(+), 1 deletions(-) diff --git a/en-US/Documentation_for_Beginners.xml b/en-US/Documentation_for_Beginners.xml index 0b97382..8acb55e 100644 --- a/en-US/Documentation_for_Beginners.xml +++ b/en-US/Documentation_for_Beginners.xml @@ -6,7 +6,8 @@ <book> <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Chapter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Why_DocBook.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> +  <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <index /> </book> diff --git a/en-US/why_docbook.xml b/en-US/Why_DocBook.xml similarity index 100% rename from en-US/why_docbook.xml rename to en-US/Why_DocBook.xml

9 years, 10 months

1
0
0 / 0

[system-administrators-guide] Apache: 2.2 to 2.4

by stephenw

commit 561fbb1823bfd4b2a4fea53744d24c50d080e247 Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Thu Aug 7 21:56:41 2014 +0200 Apache: 2.2 to 2.4 Thanks to jorton for technical review and patches. Thanks to hkario for SSL Server - recommended key size en-US/The_Apache_HTTP_Server.xml | 359 ++++++++++++++++++++++++++------------ 1 files changed, 245 insertions(+), 114 deletions(-) --- diff --git a/en-US/The_Apache_HTTP_Server.xml b/en-US/The_Apache_HTTP_Server.xml index f70321f..32f2422 100644 --- a/en-US/The_Apache_HTTP_Server.xml +++ b/en-US/The_Apache_HTTP_Server.xml @@ -8,106 +8,242 @@ <see><application>Apache HTTP Server</application></see> </indexterm> <para> - This section focuses on the <application>Apache HTTP Server 2.2</application>, a robust, full-featured open source web server developed by the <ulink url="http://www.apache.org/">Apache Software Foundation</ulink>, that is included in &MAJOROSVER;. It describes the basic configuration of the <systemitem class="service">httpd</systemitem> service, and covers advanced topics such as adding server modules, setting up virtual hosts, or configuring the secure HTTP server. + The web server available in &MAJOROSVER; is the Apache HTTP server daemon, <systemitem class="daemon">httpd</systemitem>, an open source web server developed by the <ulink url="http://www.apache.org/">Apache Software Foundation</ulink>. In &MAJOROSVER; the Apache server has been updated to <application>Apache HTTP Server 2.4</application>. This section describes the basic configuration of the <systemitem class="service">httpd</systemitem> service, and covers some advanced topics such as adding server modules, setting up virtual hosts, or configuring the secure HTTP server. </para> <para> - There are important differences between the Apache HTTP Server 2.2 and version 2.0, and if you are upgrading from a previous release of &MAJOROS;, you will need to update the <systemitem class="service">httpd</systemitem> service configuration accordingly. This section reviews some of the newly added features, outlines important changes, and guides you through the update of older configuration files. + There are important differences between the Apache HTTP Server 2.4 and version 2.2, and if you are upgrading from a previous release of &MAJOROS;, you will need to update the <systemitem class="service">httpd</systemitem> service configuration accordingly. This section reviews some of the newly added features, outlines important changes, and guides you through the update of older configuration files. </para> - <section id="s2-apache-version2-features"> - <title>New Features</title> + <section id="s2-apache-changes"> + <title>Notable Changes</title> <indexterm> <primary><application>Apache HTTP Server</application></primary> - <secondary>version 2.2</secondary> - <tertiary>features</tertiary> + <secondary>version 2.4</secondary> + <tertiary>changes</tertiary> </indexterm> <para> - The Apache HTTP Server version 2.2 introduces the following enhancements: + The Apache HTTP Server version 2.4 has the following changes: </para> - <itemizedlist> + <variablelist> + + <varlistentry> + <term>httpd Service Control</term> <listitem> <para> - <indexterm> - <primary><application>Apache HTTP Server</application></primary> - <secondary>modules</secondary> - <tertiary><systemitem class="resource">mod_cache</systemitem></tertiary> - </indexterm> - <indexterm> - <primary><application>Apache HTTP Server</application></primary> - <secondary>modules</secondary> - <tertiary><systemitem class="resource">mod_disk_cache</systemitem></tertiary> - </indexterm> - Improved caching modules, that is, <systemitem class="resource">mod_cache</systemitem> and <systemitem class="resource">mod_disk_cache</systemitem>. +With the migration away from SysV init scripts, server administrators should switch to using the <command>apachectl</command> and <command>systemctl</command> commands to control the service, in place of the <command>service</command> command. The following examples are specific to the <systemitem class="daemon">httpd</systemitem> service. +The command: +<synopsis>service httpd graceful</synopsis> +is replaced by +<synopsis>apachectl graceful</synopsis> +The command: +<synopsis>service httpd configtest</synopsis> + is replaced by + <synopsis>apachectl configtest</synopsis> +The <systemitem class="daemon">systemd</systemitem> unit file for <systemitem class="daemon">httpd</systemitem> has different behavior from the init script as follows: +<itemizedlist> + <listitem> + <para> + A graceful restart is used by default when the service is reloaded. + </para> + </listitem> + <listitem> + <para> + A graceful stop is used by default when the service is stopped. + </para> + </listitem> +</itemizedlist> + </para> </listitem> + </varlistentry> + +<varlistentry> + <term>Private /tmp</term> <listitem> <para> - <indexterm> - <primary><application>Apache HTTP Server</application></primary> - <secondary>modules</secondary> - <tertiary><systemitem class="resource">mod_proxy_balancer</systemitem></tertiary> - </indexterm> - Support for proxy load balancing, that is, the <systemitem class="resource">mod_proxy_balancer</systemitem> module. - </para> - </listitem> +To enhance system security, the <systemitem class="daemon">systemd</systemitem> unit file runs the <systemitem class="daemon">httpd</systemitem> daemon using a private <filename class="directory">/tmp</filename> directory, separate to the system <filename class="directory">/tmp</filename> directory. +</para> +</listitem> +</varlistentry> + + <varlistentry> + <term>Configuration Layout</term> <listitem> <para> - Support for large files on 32-bit architectures, allowing the web server to handle files greater than 2GB. +Configuration files which load modules are now placed in the <filename class="directory">/etc/httpd/conf.modules.d</filename> directory. Packages, such as <package>php</package>, which provide additional loadable modules for <systemitem class="daemon">httpd</systemitem> will place a file in this directory. Any configuration files in the <filename class="directory">conf.modules.d</filename> are processed before the main body of <filename>httpd.conf</filename>. Configuration files in the <filename class="directory">/etc/httpd/conf.d</filename> directory are now processed after the main body of <filename>httpd.conf</filename>.</para> +<para> +Some additional configuration files are provided by the <package>httpd</package> package itself:</para> +<itemizedlist> + <listitem> + <para> + <synopsis>/etc/httpd/conf.d/autoindex.conf</synopsis> + This configures mod_autoindex directory indexing. + </para> + </listitem> + <listitem> + <para> + <synopsis>/etc/httpd/conf.d/userdir.conf</synopsis> + This configures access to user directories, for example, <literal>http://example.com/~username/</literal>; such access is disabled by default for security reasons. + </para> + </listitem> + <listitem> + <para> +<synopsis>/etc/httpd/conf.d/welcome.conf</synopsis> + As in previous releases, this configures the welcome page displayed for <literal>http://localhost/</literal> when no content is present. </para> </listitem> + +</itemizedlist> +</listitem> + </varlistentry> + +<varlistentry> + <term>Default Configuration</term> <listitem> <para> - A new structure for authentication and authorization support, replacing the authentication modules provided in previous versions. - </para> - </listitem> - </itemizedlist> - </section> - <section id="s2-apache-version2-changes"> - <title>Notable Changes</title> - <indexterm> - <primary><application>Apache HTTP Server</application></primary> - <secondary>version 2.2</secondary> - <tertiary>changes</tertiary> - </indexterm> - <para> - Since version 2.0, few changes have been made to the default <systemitem class="service">httpd</systemitem> service configuration: - </para> - <itemizedlist> +A minimal default <filename>httpd.conf</filename> is now provided by default. Many common configuration settings, such as <literal>Timeout</literal> or <literal>KeepAlive</literal> are no longer explicitly configured in the default configuration; hard-coded settings will be used instead, by default. The hard-coded default settings for all configuration directives are specified in the manual. See <xref linkend="s3-apache-resources-installed" /> for more information. +</para> +</listitem> +</varlistentry> + +<varlistentry> + <term>Configuration Changes</term> <listitem> <para> - <indexterm> - <primary><application>Apache HTTP Server</application></primary> - <secondary>modules</secondary> - <tertiary><systemitem class="resource">mod_cern_meta</systemitem></tertiary> - </indexterm> - <indexterm> - <primary><application>Apache HTTP Server</application></primary> - <secondary>modules</secondary> - <tertiary><systemitem class="resource">mod_asis</systemitem></tertiary> - </indexterm> - The following modules are no longer loaded by default: <systemitem class="resource">mod_cern_meta</systemitem> and <systemitem class="resource">mod_asis</systemitem>. - </para> - </listitem> +A number of backwards-incompatible changes to the <systemitem class="daemon">httpd</systemitem> configuration syntax were made which will require changes if migrating an existing configuration from <application>httpd 2.2</application> to <application>httpd 2.4</application>. See the following Apache document for more information on upgrading <ulink url="http://httpd.apache.org/docs/2.4/upgrading.html" /> +</para> +</listitem> +</varlistentry> + + +<varlistentry> + <term>Processing Model</term> <listitem> <para> - <indexterm> - <primary><application>Apache HTTP Server</application></primary> - <secondary>modules</secondary> - <tertiary><systemitem class="resource">mod_ext_filter</systemitem></tertiary> - </indexterm> - The following module is newly loaded by default: <systemitem class="resource">mod_ext_filter</systemitem>. - </para> - </listitem> - </itemizedlist> +In previous releases of &MAJOROS;, different <firstterm>multi-processing models</firstterm> (<acronym>MPM</acronym>) were made available as different <systemitem class="daemon">httpd</systemitem> binaries: the forked model, <quote>prefork</quote>, as <filename>/usr/sbin/httpd</filename>, and the thread-based model <quote>worker</quote> as <filename>/usr/sbin/httpd.worker</filename>.</para> +<para> +In &MAJOROSVER;, only a single <systemitem class="daemon">httpd</systemitem> binary is used, and three MPMs are available as loadable modules: worker, prefork (default), and event. The configuration file <filename>/etc/httpd/conf.modules.d/00-mpm.conf</filename> can be changed to select which of the three MPM modules is loaded.</para> +</listitem> +</varlistentry> +<varlistentry> + <term>Packaging Changes</term> + <listitem> + <para> +The LDAP authentication and authorization modules are now provided in a separate sub-package <package>mod_ldap</package>. The new module <application>mod_session</application> and associated helper modules are provided in a new sub-package, <package>mod_session</package>. The new modules <application>mod_proxy_html</application> and <application>mod_xml2enc</application> are provided in a new sub-package, <package>mod_proxy_html</package>. +</para> +</listitem> +</varlistentry> +<varlistentry> + <term>Packaging Filesystem Layout</term> + <listitem> + <para> +The <filename class="directory">/var/cache/mod_proxy</filename> directory is no longer provided; instead, the <filename class="directory">/var/cache/httpd/</filename> directory is packaged with a <literal>proxy</literal> and <literal>ssl</literal> subdirectory. +</para> +<para> +Packaged content provided with <systemitem class="daemon">httpd</systemitem> has been moved from <filename class="directory">/var/www/</filename> to <filename class="directory">/usr/share/httpd/</filename>: +<itemizedlist> +<listitem> +<para> + <synopsis>/usr/share/httpd/icons/</synopsis> + The <filename class="directory">/var/www/icons/</filename> has moved to <filename class="directory">/usr/share/httpd/icons</filename>. This directory contains a set of icons used with directory indices. Available at <literal>http://localhost/icons/</literal> in the default configuration, via <filename>/etc/httpd/conf.d/autoindex.conf</filename>. + </para> + </listitem> + +<listitem> +<para> + <synopsis>/usr/share/httpd/manual/</synopsis> + The <filename class="directory">/var/www/manual/</filename> has moved to <filename class="directory">/usr/share/httpd/manual/</filename>. This directory, contained in the <package>httpd-manual</package> package, contains the HTML version of the manual for <systemitem class="daemon">httpd</systemitem>. Available at <literal>http://localhost/manual/</literal> if the package is installed, via <literal>/etc/httpd/conf.d/manual.conf</literal>.</para> + </listitem> +<listitem> +<para> + <synopsis>/usr/share/httpd/error/</synopsis> + The <filename class="directory">/var/www/error/</filename> has moved to <filename class="directory">/usr/share/httpd/error/</filename>. Custom multi-language HTTP error pages. Not configured by default, the example configuration file is provided at <filename>/usr/share/doc/httpd-<replaceable>VERSION</replaceable>/httpd-multilang-errordoc.conf</filename>. + </para> + </listitem> + +</itemizedlist> + +</para> +</listitem> +</varlistentry> + + </variablelist> + + +<variablelist> +<varlistentry> + <term>Authentication, Authorization and Access Control</term> + <listitem> + <para> +The configuration directives used to control authentication, authorization and access control have changed significantly. Existing configuration files using the <literal>Order</literal>, <literal>Deny</literal> and <literal>Allow</literal> directives should be adapted to use the new <literal>Require</literal> syntax. See the following Apache document for more information <ulink url="http://httpd.apache.org/docs/2.4/howto/auth.html" /> +</para> +</listitem> +</varlistentry> +<varlistentry> + <term>suexec</term> + <listitem> + <para> +To improve system security, the <application>suexec</application> binary is no longer installed <literal>setuid root</literal>; instead, it has file system capability bits set which allow a more restrictive set of permissions. In conjunction with this change, the <application>suexec</application> binary no longer uses the <filename>/var/log/httpd/suexec.log</filename> logfile. Instead, log messages are sent to <application>syslog</application>; by default these will appear in the <filename>/var/log/secure</filename> log file. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Module Interface</term> +<listitem> +<para> +Due to changes to the <systemitem class="daemon">httpd</systemitem> module interface, <application>httpd 2.4</application> is not compatible with third-party binary modules built against <application>httpd 2.2</application>. Such modules will need to be adjusted as necessary for the <application>httpd 2.4</application> module interface, and then rebuilt. A detailed list of the API changes in version <literal>2.4</literal> is available here: <ulink url="http://httpd.apache.org/docs/2.4/developer/new_api_2_4.html" />. +</para> +<para> +The <application>apxs</application> binary used to build modules from source has moved from <filename>/usr/sbin/apxs</filename> to <filename>/usr/bin/apxs</filename>. +</para> +</listitem> +</varlistentry> +<varlistentry> + <term>Removed modules</term> + <listitem> + <para> +List of <systemitem class="daemon">httpd</systemitem> modules removed in &MAJOROSVER;: +<variablelist> + <varlistentry> + <term>mod_auth_mysql, mod_auth_pgsql</term> + <listitem> + <para> + <application>httpd 2.4</application> provides SQL database authentication support internally in the <application>mod_authn_dbd</application> module. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>mod_perl</term> + <listitem> + <para> + <application>mod_perl</application> is not officially supported with <application>httpd 2.4</application> by upstream. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>mod_authz_ldap</term> + <listitem> + <para> + <application>httpd 2.4</application> provides LDAP support internally using <application>mod_authnz_ldap</application>. + </para> + </listitem> + </varlistentry> + +</variablelist> +</para> +</listitem> +</varlistentry> +</variablelist> + </section> <section id="s2-apache-version2-migrating"> <title>Updating the Configuration</title> <indexterm> <primary><application>Apache HTTP Server</application></primary> - <secondary>version 2.2</secondary> - <tertiary>updating from version 2.0</tertiary> + <secondary>version 2.4</secondary> + <tertiary>updating from version 2.2</tertiary> </indexterm> <para> - To update the configuration files from the Apache HTTP Server version 2.0, take the following steps: + To update the configuration files from the Apache HTTP Server version 2.2, take the following steps: </para> <procedure> <step> @@ -139,19 +275,20 @@ <para> Note that you can check the configuration for possible errors by using the following command: </para> - <screen><command>service httpd configtest</command></screen> + <screen>~]# <command>service httpd configtest</command> +Syntax OK</screen> <para> - For more information on upgrading the Apache HTTP Server configuration from version 2.0 to 2.2, refer to <ulink url="http://httpd.apache.org/docs/2.2/upgrading.html" />. + For more information on upgrading the Apache HTTP Server configuration from version 2.2 to 2.4, see <ulink url="http://httpd.apache.org/docs/2.4/upgrading.html"/>. </para> </section> <section id="s2-apache-running"> <title>Running the httpd Service</title> <para> - This section describes how to start, stop, restart, and check the current status of the Apache HTTP Server. To be able to use the <systemitem class="service">httpd</systemitem> service, make sure you have the <package>httpd</package> installed. You can do so by using the following command as <systemitem class="username">root</systemitem>: + This section describes how to start, stop, restart, and check the current status of the Apache HTTP Server. To be able to use the <systemitem class="service">httpd</systemitem> service, make sure you have the <package>httpd</package> installed. You can do so by using the following command: </para> - <screen><command>yum install httpd</command></screen> + <screen>~]# <command>yum install httpd</command></screen> <para> - For more information on the concept of runlevels and how to manage system services in &MAJOROS; in general, refer to <xref linkend="ch-Services_and_Daemons" />. + For more information on the concept of targets and how to manage system services in &MAJOROS; in general, see <remark>link to systemd section when ready</remark> <xref linkend="ch-Services_and_Daemons" />. </para> <section id="s3-apache-running-starting"> <title>Starting the Service</title> @@ -162,14 +299,12 @@ <para> To run the <systemitem class="service">httpd</systemitem> service, type the following at a shell prompt as <systemitem class="username">root</systemitem>: </para> - <screen><command>systemctl start httpd.service</command></screen> + <screen>~]# <command>systemctl start httpd.service</command></screen> <para> If you want the service to start automatically at the boot time, use the following command: </para> - <screen><command>systemctl enable httpd.service</command></screen> - <para> - See <xref linkend="ch-Services_and_Daemons" /> for more information on how to configure services in &MAJOROS;. - </para> + <screen>~]# <command>systemctl enable httpd.service</command> +ln -s '/usr/lib/systemd/system/httpd.service' '/etc/systemd/system/multi-user.target.wants/httpd.service'</screen> <note> <title>Using the secure server</title> <para> @@ -186,14 +321,12 @@ <para> To stop the running <systemitem class="service">httpd</systemitem> service, type the following at a shell prompt as <systemitem class="username">root</systemitem>: </para> - <screen><command>systemctl stop httpd.service</command></screen> + <screen>~]# <command>systemctl stop httpd.service</command></screen> <para> To prevent the service from starting automatically at the boot time, type: </para> - <screen><command>systemctl disable httpd.service</command></screen> - <para> - See <xref linkend="ch-Services_and_Daemons" /> for more information on how to configure services in &MAJOROS;. - </para> + <screen>~]# <command>systemctl disable httpd.service</command> +rm '/etc/systemd/system/multi-user.target.wants/httpd.service'</screen> </section> <section id="s3-apache-running-restarting"> <title>Restarting the Service</title> @@ -202,54 +335,52 @@ <secondary>restarting</secondary> </indexterm> <para> - There are two different ways to restart the running <systemitem class="service">httpd</systemitem> service: + There are three different ways to restart a running <systemitem class="service">httpd</systemitem> service: </para> <orderedlist> <listitem> <para> To restart the service completely, type the following at a shell prompt as <systemitem class="username">root</systemitem>: </para> - <screen><command>systemctl restart httpd.service</command></screen> + <screen>~]# <command>systemctl restart httpd.service</command></screen> <para> - This will stop the running <systemitem class="service">httpd</systemitem> service, and then start it again. Use this command after installing or removing a dynamically loaded module such as PHP. + This stops the running <systemitem class="service">httpd</systemitem> service and immediately starts it again. Use this command after installing or removing a dynamically loaded module such as PHP. </para> </listitem> <listitem> <para> To only reload the configuration, as <systemitem class="username">root</systemitem>, type: </para> - <screen><command>systemctl reload httpd.service</command></screen> + <screen>~]# <command>systemctl reload httpd.service</command></screen> <para> - This will cause the running <systemitem class="service">httpd</systemitem> service to reload the configuration file. Note that any requests being currently processed will be interrupted, which may cause a client browser to display an error message or render a partial page. + This causes the running <systemitem class="service">httpd</systemitem> service to reload its configuration file. Any requests being currently processed will be interrupted, which may cause a client browser to display an error message or render a partial page. </para> </listitem> <listitem> <para> To reload the configuration without affecting active requests, run the following command as <systemitem class="username">root</systemitem>: </para> - <screen><command>service httpd graceful</command></screen> + <screen>~]# <command>service httpd graceful</command></screen> <para> - This will cause the running <systemitem class="service">httpd</systemitem> service to reload the configuration file. Note that any requests being currently processed will use the old configuration. + This cause the running <systemitem class="service">httpd</systemitem> service to reload its configuration file. Any requests being currently processed will use the old configuration. </para> </listitem> </orderedlist> <para> - See <xref linkend="ch-Services_and_Daemons" /> for more information on how to configure services in &MAJOROS;. +  </para> </section> <section id="s3-apache-running-status"> - <title>Checking the Service Status</title> + <title>Verifying the Service Status</title> <indexterm> <primary><application>Apache HTTP Server</application></primary> <secondary>checking status</secondary> </indexterm> <para> - To check whether the service is running, type the following at a shell prompt: - </para> - <screen><command>systemctl is-active httpd.service</command></screen> - <para> - See <xref linkend="ch-Services_and_Daemons" /> for more information on how to configure services in &MAJOROS;. + To verify that the <systemitem class="service">httpd</systemitem> service is running, type the following at a shell prompt: </para> + <screen>~]# <command>systemctl is-active httpd.service</command> +active</screen> </section> </section> <section id="s2-apache-editing"> @@ -312,7 +443,8 @@ <para> To check the configuration for possible errors, type the following at a shell prompt: </para> - <screen><command>service httpd configtest</command></screen> + <screen>~]# <command>service httpd configtest</command> +Syntax OK</screen> <para> To make the recovery from mistakes easier, it is recommended that you make a copy of the original file before editing it. </para> @@ -3635,14 +3767,14 @@ ErrorDocument 404 /404-not_found.html</programlisting> <para> If you intend to create a new DSO module, make sure you have the <package>httpd-devel</package> package installed. To do so, type the following at a shell prompt as <systemitem class="username">root</systemitem>: </para> - <screen><command>yum install httpd-devel</command></screen> + <screen>~]# <command>yum install httpd-devel</command></screen> <para> This package contains the include files, the header files, and the <application>APache eXtenSion</application> (<command>apxs</command>) utility required to compile a module. </para> <para> Once written, you can build the module with the following command: </para> - <screen><command>apxs -i -a -c <replaceable>module_name</replaceable>.c</command></screen> + <screen>~]# <command>apxs -i -a -c <replaceable>module_name</replaceable>.c</command></screen> <para> If the build was successful, you should be able to load the module the same way as any other module that is distributed with the Apache HTTP Server. </para> @@ -3786,8 +3918,7 @@ ErrorDocument 404 /404-not_found.html</programlisting> <entry> <application>Opera</application> </entry> - <entry> - <ulink url="http://my.opera.com/rootstore/blog/">The Opera Rootstore</ulink>. + <entry><ulink url="http://www.opera.com/docs/ca/">Root certificates used by Opera</ulink>. </entry> </row> <row> @@ -3810,7 +3941,7 @@ ErrorDocument 404 /404-not_found.html</programlisting> <para> If you intend to set up an SSL server, make sure you have the <package>mod_ssl</package> (the <systemitem class="resource">mod_ssl</systemitem> module) and <package>openssl</package> (the OpenSSL toolkit) packages installed. To do so, type the following at a shell prompt as <systemitem class="username">root</systemitem>: </para> - <screen><command>yum install mod_ssl openssl</command></screen> + <screen>~]# <command>yum install mod_ssl openssl</command></screen> <indexterm> <primary><application>Apache HTTP Server</application></primary> <secondary>files</secondary> @@ -3854,13 +3985,13 @@ ErrorDocument 404 /404-not_found.html</programlisting> </listitem> </orderedlist> <para> - In either of the above cases, you will need to obtain a new certificate. For more information on this topic, refer to <xref linkend="s3-apache-mod_ssl-genkey" />. + In either of the above cases, you will need to obtain a new certificate. For more information on this topic, see <xref linkend="s3-apache-mod_ssl-genkey"/>. </para> <para> If you wish to use an existing key and certificate, move the relevant files to the <filename class="directory">/etc/pki/tls/private/</filename> and <filename class="directory">/etc/pki/tls/certs/</filename> directories respectively. You can do so by running the following commands as <systemitem class="username">root</systemitem>: </para> - <screen><command>mv</command> <filename><replaceable>key_file</replaceable>.key</filename> <filename>/etc/pki/tls/private/<replaceable>hostname</replaceable>.key</filename> -<command>mv</command> <filename><replaceable>certificate</replaceable>.crt</filename> <filename>/etc/pki/tls/certs/<replaceable>hostname</replaceable>.crt</filename></screen> + <screen>~]# <command>mv</command> <filename><replaceable>key_file</replaceable>.key</filename> <filename>/etc/pki/tls/private/<replaceable>hostname</replaceable>.key</filename> +~]# <command>mv</command> <filename><replaceable>certificate</replaceable>.crt</filename> <filename>/etc/pki/tls/certs/<replaceable>hostname</replaceable>.crt</filename></screen> <para> Then add the following lines to the <filename>/etc/httpd/conf.d/ssl.conf</filename> configuration file: </para> @@ -3890,7 +4021,7 @@ SSLCertificateKeyFile /etc/pki/tls/private/<replaceable>hostname</replaceable>.k <para> In order to generate a new key and certificate pair, you must to have the <package>crypto-utils</package> package installed in your system. As <systemitem class="username">root</systemitem>, you can install it by typing the following at a shell prompt: </para> - <screen><command>yum install crypto-utils</command></screen> + <screen>~]# <command>yum install crypto-utils</command></screen> <para> This package provides a set of tools to generate and manage SSL certificates and private keys, and includes <application>genkey</application>, the Red Hat Keypair Generation utility that will guide you through the key generation process. </para> @@ -3899,19 +4030,19 @@ SSLCertificateKeyFile /etc/pki/tls/private/<replaceable>hostname</replaceable>.k <para> If the server already has a valid certificate and you are replacing it with a new one, specify a different serial number. This ensures that client browsers are notified of this change, update to this new certificate as expected, and do not fail to access the page. To create a new certificate with a custom serial number, as <systemitem class="username">root</systemitem>, use the following command instead of <application>genkey</application>: </para> - <screen><command>openssl req -x509 -new -set_serial <replaceable>number</replaceable> -key <replaceable>hostname</replaceable>.key -out <replaceable>hostname</replaceable>.crt</command></screen> + <screen>~]# <command>openssl req -x509 -new -set_serial <replaceable>number</replaceable> -key <replaceable>hostname</replaceable>.key -out <replaceable>hostname</replaceable>.crt</command></screen> </important> <note> <title>Remove a previously created key</title> <para> If there already is a key file for a particular hostname in your system, <application>genkey</application> will refuse to start. In this case, remove the existing file using the following command as <systemitem class="username">root</systemitem>: </para> - <screen><command>rm /etc/pki/tls/private/<replaceable>hostname</replaceable>.key</command></screen> + <screen>~]# <command>rm /etc/pki/tls/private/<replaceable>hostname</replaceable>.key</command></screen> </note> <para> - To run the utility, as <systemitem class="username">root</systemitem>, run the <command>genkey</command> command followed by the appropriate hostname (for example, <systemitem class="domainname">penguin.example.com</systemitem>): + To run the utility, as <systemitem class="username">root</systemitem>, run the <command>genkey</command> command followed by the appropriate host name (for example, <systemitem class="domainname">penguin.example.com</systemitem>): </para> - <screen><command>genkey</command> <replaceable>hostname</replaceable></screen> + <screen>~]# <command>genkey</command> <replaceable>hostname</replaceable></screen> <para> To complete the key and certificate creation, take the following steps: </para> @@ -3939,7 +4070,7 @@ SSLCertificateKeyFile /etc/pki/tls/private/<replaceable>hostname</replaceable>.k </step> <step> <para> - Using the <keycap>Up</keycap> and <keycap>down</keycap> arrow keys, select the suitable key size. Note that while the large key increases the security, it also increases the response time of your server. Because of this, the recommended option is <literal>1024 bits</literal>. + Using the <keycap>Up</keycap> and <keycap>down</keycap> arrow keys, select the suitable key size. Note that while the large key increases the security, it also increases the response time of your server. The NIST recommends using <literal>2048 bits</literal>. See <ulink url="http://csrc.nist.gov/publications/nistpubs/800-131A/sp800-131A.pdf"><citetitle pubwork="book">NIST Special Publication 800-131A</citetitle></ulink>. </para> <figure id="figure-apache-mod_ssl-genkey-02"> <title>Selecting the key size</title> @@ -4083,7 +4214,7 @@ SSLCertificateKeyFile /etc/pki/tls/private/<replaceable>hostname</replaceable>.k <section id="s2-apache-resources"> <title>Additional Resources</title> <para> - To learn more about the Apache HTTP Server, refer to the following resources. + To learn more about the Apache HTTP Server, see the following resources. </para> <section id="s3-apache-resources-installed"> <title>Installed Documentation</title>

9 years, 10 months

1
0
0 / 0

[docs-beginner] master: Add another note (40bd5e6)

by Jared K. Smith

Repository : http://git.fedorahosted.org/cgit/docs-beginner.git On branch : master >--------------------------------------------------------------- commit 40bd5e68e4dccb2108261bc24342e9d2ad5c1d2d Author: Jared K. Smith <jaredsmith(a)jaredsmith.net> Date: Thu Aug 7 10:44:47 2014 -0400 Add another note >--------------------------------------------------------------- TODO.txt | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/TODO.txt b/TODO.txt index 6714bc1..13f5ac1 100644 --- a/TODO.txt +++ b/TODO.txt @@ -16,3 +16,7 @@ * footnotes * Indices and glossaries * Revision history +* Using the power of your editor (plugins, snippets, etc. for your editor) + - vim + - emacs + - gedit

9 years, 10 months

1
0
0 / 0

[docs-beginner] master: Introduction to the why of docbook (2a4601d)

by Jared K. Smith

Repository : http://git.fedorahosted.org/cgit/docs-beginner.git On branch : master >--------------------------------------------------------------- commit 2a4601dafd55c724c103106ad52d58a66e64f65e Author: Jared K. Smith <jaredsmith(a)jaredsmith.net> Date: Thu Aug 7 10:34:44 2014 -0400 Introduction to the why of docbook >--------------------------------------------------------------- en-US/why_docbook.xml | 65 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 65 insertions(+), 0 deletions(-) diff --git a/en-US/why_docbook.xml b/en-US/why_docbook.xml new file mode 100644 index 0000000..0815625 --- /dev/null +++ b/en-US/why_docbook.xml @@ -0,0 +1,65 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Documentation_Guide.ent"> +%BOOK_ENTITIES; +]> + +<chapter id="chap-why-docbook"> + <title>Why DocBook?</title> + <para> + DocBook has many features which make it suitable for + documentation in Fedora and other projects. + </para> + <section> + <title>DocBook as an XML Markup Language</title> + <para> + DocBook is an implementation of + <firstterm>Extensible Markup Language (XML) + </firstterm>. XML gives DocBook powerful + flexibility. + </para> + </section> + <section> + <title>Human-readable Tags</title> + <para> + DocBook tags are generally self-explaining. + They are named after what they define, even + though shorter terms might make more effiecient + use of space. This makes it easy for writers + and editors to quickly look at a document and + understand how it is constructed. + </para> + </section> + <section> + <title>Text-based Format for Easy Revision Control</title> + <para> + Version control provides two critical features + for collaborative documentation work: + concurrent editing and history. The text-based + format of DocBook makes it well-suited to + being managed by a version control system. + </para> + </section> + <section> + <title>Separation Between Content and Style</title> + <para> + The DocBook standard separates a document's + content and its formatting. The writer uses XML + tags to structure the elements of document, and + the formatting can be changed independently + later. A change to the formatting of an element + does not require changing every instance of that + element. + </para> + </section> + <section> + <title>Output in a Variety of Formats</title> + <para> + DocBook is a source format. The + <command>publican</command> tool is used to + generate rendered documents in several different + formats. publican can generate HTML, PDF, and + epub formats from the same source file. + </para> + </section> +</chapter>

9 years, 10 months

1
0
0 / 0

[docs-beginner] master: Add an initial to do list (741c0e8)

by Jared K. Smith

Repository : http://git.fedorahosted.org/cgit/docs-beginner.git On branch : master >--------------------------------------------------------------- commit 741c0e85dc2a033f98684449ea833da39f8e8e00 Author: Jared K. Smith <jaredsmith(a)jaredsmith.net> Date: Thu Aug 7 10:22:17 2014 -0400 Add an initial to do list >--------------------------------------------------------------- TODO.txt | 18 ++++++++++++++++++ 1 files changed, 18 insertions(+), 0 deletions(-) diff --git a/TODO.txt b/TODO.txt new file mode 100644 index 0000000..6714bc1 --- /dev/null +++ b/TODO.txt @@ -0,0 +1,18 @@ +* Introduction to docbook itself +* Introduction to the way Publican organizes a docbook project +* Book/Chapter/Section/Para +* XIncludes for breaking up into multiple files +* Entities (but they break translation) +* Add a new para to an existing book +* Adding a new section to an existing chapter +* Adding a new chapter (in its own file) -- don't forget the XInclude +* publican test +* publican build (html, html-single, pdf, epub?)j +* Learning more tags (section, para, lists (different types), procedures) +* Adding media (images, etc.) +* Semantic markup: Tagging things like applications, commands, parameters, options, packages, etc. +* Screens, programlistings, synopsis, callouts, etc. +* Adding tables +* footnotes +* Indices and glossaries +* Revision history

9 years, 10 months

1
0
0 / 0

[system-administrators-guide] Samba: Updating the resources section

by stephenw

commit 201060a20d581cd5d786b926f7e0b48aa09be806 Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Wed Aug 6 23:41:51 2014 +0200 Samba: Updating the resources section there is no more samba-doc package en-US/Samba.xml | 14 +++++--------- 1 files changed, 5 insertions(+), 9 deletions(-) --- diff --git a/en-US/Samba.xml b/en-US/Samba.xml index 48372b1..b201af5 100644 --- a/en-US/Samba.xml +++ b/en-US/Samba.xml @@ -1741,17 +1741,13 @@ Press enter to see a dump of your service definitions </indexterm> <itemizedlist> <listitem> - <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> - <screen><command>yum install samba-doc</command></screen> - <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para> - </note> + + <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.</para> </listitem> </itemizedlist> <para> - See the following manual pages for detailed information specific <application>Samba</application> features: + See the following manual pages for detailed information about <application>Samba</application>: </para> <itemizedlist> <listitem> @@ -1826,7 +1822,7 @@ Press enter to see a dump of your service definitions url="http://us1.samba.org/samba/archives.html">http://samba.org/samba/archives.html </ulink> — Active email lists for the Samba community. Enabling digest mode is recommended due to high levels of list activity.</para> </listitem> <listitem> - <para>Samba newsgroups — Samba threaded newsgroups, such as gmane.org, that use the NNTP protocol are also available. This an alternative to receiving mailing list emails.</para> + <para>Samba newsgroups — Samba threaded newsgroups, such as <ulink url="http://www.gmane.org/">www.gmane.org</ulink>, that use the <systemitem class="protocol">NNTP</systemitem> protocol are also available. This an alternative to receiving mailing list emails.</para> </listitem> </itemizedlist> </section>

9 years, 10 months

1
0
0 / 0

[system-administrators-guide] Samba: Style, formating, and typos

by stephenw

commit 24d50a45c1d74ef441d242c37072a5e8377fd643 Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Wed Aug 6 23:35:21 2014 +0200 Samba: Style, formating, and typos en-US/Samba.xml | 61 ++++++++++++++++++++++++++++--------------------------- 1 files changed, 31 insertions(+), 30 deletions(-) --- diff --git a/en-US/Samba.xml b/en-US/Samba.xml index 371289b..48372b1 100644 --- a/en-US/Samba.xml +++ b/en-US/Samba.xml @@ -18,8 +18,8 @@ <note> <title>Installing the samba package</title> <para>In order to use <application>Samba</application>, first ensure the <package>samba</package> package is installed on your system by running, as <systemitem class="username">root</systemitem>:</para> - <screen><command>yum install samba</command></screen> - <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para> + <screen>~]# <command>yum install samba</command></screen> + <para>For more information on installing packages with Yum, see <xref linkend="sec-Installing"/>.</para> </note> <section @@ -39,7 +39,7 @@ <primary>Samba</primary> <secondary>Abilities</secondary> </indexterm> - <para>Samba is a powerful and versatile server application. Even seasoned system administrators must know its abilities and limitations before attempting installation and configuration.</para> + <para>Samba is a powerful and versatile server application.</para> <para>What Samba can do:</para> <itemizedlist> <listitem> @@ -133,8 +133,7 @@ <para>The <command>winbindd</command> daemon is controlled by the <command>winbind</command> service and does not require the <command>smb</command> service to be started in order to operate. <command>winbindd</command> is also used when Samba is an Active Directory member, and may also be used on a Samba domain controller (to implement nested groups and interdomain trust). Because <command>winbind</command> is a client-side service used to connect to Windows NT-based servers, further discussion of <command>winbind</command> is beyond the scope of this chapter.</para> <note> <title>Obtaining a list of utilities that are shipped with Samba</title> - <para>You may refer to <xref - linkend="s2-samba-programs"/> for a list of utilities included in the Samba distribution.</para> + <para>See <xref linkend="s2-samba-programs"/> for a list of utilities included in the Samba distribution.</para> </note> </section> </section> @@ -200,7 +199,7 @@ </primary> </indexterm> <para>To connect to a Samba share from a shell prompt, type the following command:</para> - <screen><command>smbclient //<replaceable>hostname</replaceable>/<replaceable>sharename</replaceable> -U <replaceable>username</replaceable></command></screen> + <screen>~]$ <command>smbclient //<replaceable>hostname</replaceable>/<replaceable>sharename</replaceable> -U <replaceable>username</replaceable></command></screen> <para>Replace <replaceable>hostname</replaceable> with the hostname or <systemitem class="protocol">IP</systemitem> address of the Samba server you want to connect to, <replaceable>sharename</replaceable> with the name of the shared directory you want to browse, and <replaceable>username</replaceable> with the Samba username for the system. Enter the correct password or press <keycap>Enter</keycap> if no password is required for the user.</para> <para>If you see the <prompt>smb:\></prompt> prompt, you have successfully logged in. Once you are logged in, type <userinput>help</userinput> for a list of commands. If you wish to browse the contents of your home directory, replace <replaceable>sharename</replaceable> with your username. If the <command>-U</command> switch is not used, the username of the current user is passed to the Samba server.</para> <para>To exit <command>smbclient</command>, type <userinput>exit</userinput> at the <prompt>smb:\></prompt> prompt.</para> @@ -223,21 +222,21 @@ <note> <title>Installing cifs-utils package</title> <para>The <application>mount.cifs</application> utility is a separate RPM (independent from Samba). In order to use <application>mount.cifs</application>, first ensure the <package>cifs-utils</package> package is installed on your system by running, as <systemitem class="username">root</systemitem>:</para> - <screen><command>yum install cifs-utils</command></screen> - <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para> + <screen>~]# <command>yum install cifs-utils</command></screen> + <para>For more information on installing packages with Yum, see <xref linkend="sec-Installing"/>.</para> <para> - Note that the <package>cifs-utils</package> package also contains the <application>cifs.upcall</application> binary called by the kernel in order to perform kerberized CIFS mounts. For more information on <application>cifs.upcall</application>, refer to <command>man cifs.upcall</command>. + Note that the <package>cifs-utils</package> package also contains the <application>cifs.upcall</application> binary called by the kernel in order to perform kerberized CIFS mounts. For more information on <application>cifs.upcall</application>, see <command>man cifs.upcall</command>. </para> </note> <para> - For more information about mounting a samba share, refer to <command>man mount.cifs</command>. + For more information about mounting a samba share, see <command>man mount.cifs</command>. </para> <warning> <title>CIFS servers that require plain text passwords</title> <para> Some CIFS servers require plain text passwords for authentication. Support for plain text password authentication can be enabled using the following command as <systemitem class="username">root</systemitem>: </para> - <screen><command>echo 0x37 > /proc/fs/cifs/SecurityFlags</command></screen> + <screen>~]# <command>echo 0x37 > /proc/fs/cifs/SecurityFlags</command></screen> <para> WARNING: This operation can expose passwords by removing password encryption. </para> @@ -259,7 +258,7 @@ <secondary>configuration</secondary> <tertiary>default</tertiary> </indexterm> - <para>The default configuration file (<filename>/etc/samba/smb.conf</filename>) allows users to view their home directories as a Samba share. It also shares all printers configured for the system as Samba shared printers. In other words, you can attach a printer to the system and print to it from the Windows machines on your network.</para> + <para>The default configuration file (<filename>/etc/samba/smb.conf</filename>) allows users to view their home directories as a Samba share. It also shares all printers configured for the system as Samba shared printers. You can attach a printer to the system and print to it from the Windows machines on your network.</para> <section id="s3-samba-configuring-gui"> <title>Graphical Configuration</title> @@ -281,7 +280,7 @@ <secondary>configuration</secondary> </indexterm> <para>Samba uses <filename>/etc/samba/smb.conf</filename> as its configuration file. If you change this configuration file, the changes do not take effect until you restart the Samba daemon with the following command, as <systemitem class="username">root</systemitem>: - <screen><command>systemctl restart smb.service</command></screen> + <screen>~]# <command>systemctl restart smb.service</command></screen> </para> <para>To specify the Windows workgroup and a brief description of the Samba server, edit the following lines in your <filename>/etc/samba/smb.conf</filename> file:</para> <programlisting>workgroup = <replaceable>WORKGROUPNAME</replaceable> @@ -374,26 +373,28 @@ create mask = 0765</programlisting> <tertiary>reloading</tertiary> </indexterm> <para>To start a Samba server, type the following command in a shell prompt, as <systemitem class="username">root</systemitem>:</para> -<screen><command>systemctl start smb.service</command></screen> +<screen>~]# <command>systemctl start smb.service</command></screen> <important> <title>Setting up a domain member server</title> <para>To set up a domain member server, you must first join the domain or Active Directory using the <command>net join</command> command <emphasis>before</emphasis> starting the <command>smb</command> service. Also, it is recommended to run <systemitem class="daemon">winbind</systemitem> before <systemitem class="daemon">smbd</systemitem>.</para> </important> <para>To stop the server, type the following command in a shell prompt, as <systemitem class="username">root</systemitem>:</para> - <screen><command>systemctl stop smb.service</command></screen> + <screen>~]# <command>systemctl stop smb.service</command></screen> <para>The <option>restart</option> option is a quick way of stopping and then starting Samba. This is the most reliable way to make configuration changes take effect after editing the configuration file for Samba. Note that the restart option starts the daemon even if it was not running originally.</para> <para>To restart the server, type the following command in a shell prompt, as <systemitem class="username">root</systemitem>:</para> - <screen><command>systemctl restart smb.service</command></screen> + <screen>~]# <command>systemctl restart smb.service</command></screen> <para>The <option>condrestart</option> (<firstterm>conditional restart</firstterm>) option only starts <command>smb</command> on the condition that it is currently running. This option is useful for scripts, because it does not start the daemon if it is not running.</para> <note> <title>Applying the changes to the configuration</title> <para>When the <filename>/etc/samba/smb.conf</filename> file is changed, Samba automatically reloads it after a few minutes. Issuing a manual <command>restart</command> or <command>reload</command> is just as effective.</para> </note> <para>To conditionally restart the server, type the following command, as <systemitem class="username">root</systemitem>:</para> - <screen><command>systemctl condrestart smb.service</command></screen> + <screen>~]# <command>systemctl condrestart smb.service</command></screen> <para>A manual reload of the <filename>/etc/samba/smb.conf</filename> file can be useful in case of a failed automatic reload by the <command>smb</command> service. To ensure that the Samba server configuration file is reloaded without restarting the service, type the following command, as <systemitem class="username">root</systemitem>:</para> - <screen><command>systemctl reload smb.service</command></screen> - <para>By default, the <command>smb</command> service does <emphasis>not</emphasis> start automatically at boot time. To configure Samba to start at boot time, use a service manager such as <command>systemctl</command>. See <xref linkend="ch-Services_and_Daemons" /> for more information regarding this tool.</para> + <screen><command>systemctl reload smb.service</command></screen> + <para>By default, the <command>smb</command> service does <emphasis>not</emphasis> start automatically at boot time. To configure Samba to start at boot time, type the following at a shell prompt as <systemitem class="username">root</systemitem>:</para> + <screen>~]# <command>systemctl enable smb.service</command></screen> +<para>See <xref linkend="ch-Services_and_Daemons" /> for more information regarding this tool.</para> </section> <section id="s2-samba-servers"> @@ -1171,9 +1172,8 @@ os level = 0</screen> <secondary>Network Browsing</secondary> <tertiary>Domain Browsing</tertiary> </indexterm> - <para>By default, a Windows server PDC for a domain is also the domain master browser for that domain. A Samba server must <emphasis>not</emphasis> be set up as a domain master server in this type of situation</para> - - <para>For subnets that do not include the Windows server PDC, a Samba server can be implemented as a local master browser. Configuring the <filename>/etc/samba/smb.conf</filename> file for a local master browser (or no browsing at all) in a domain controller environment is the same as workgroup configuration.</para> + <para>By default, a Windows server PDC for a domain is also the domain master browser for that domain. A Samba server must <emphasis>not</emphasis> be set up as a domain master server in this type of situation.</para> + <para>For subnets that do not include the Windows server PDC, a Samba server can be implemented as a local master browser. Configuring the <filename>/etc/samba/smb.conf</filename> file for a local master browser (or no browsing at all) in a domain controller environment is the same as workgroup configuration (see <xref linkend="s2-samba-configuring" />).</para> </section> <section id="s3-samba-wins"> @@ -1329,7 +1329,7 @@ IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION <screen><command>net <replaceable>protocol function misc_options target_options</replaceable></command></screen> <para>The <command>net</command> utility is similar to the <command>net</command> utility used for Windows and MS-DOS. The first argument is used to specify the protocol to use when executing a command. The <command><replaceable>protocol</replaceable> </command> option can be <command>ads</command>, <command>rap</command>, or <command>rpc</command> for specifying the type of server connection. Active Directory uses <command>ads</command>, Win9x/NT3 uses <command>rap</command>, and Windows NT4/2000/2003/2008 uses <command>rpc</command>. If the protocol is omitted, <command>net</command> automatically tries to determine it.</para> - <para>The following example displays a list the available shares for a host named <command>wakko</command>:</para> + <para>The following example displays a list of the available shares for a host named <command>wakko</command>:</para> <screen>~]$ <command>net -l share -S wakko</command> Password: Enumerating shared resources (exports) on remote server: @@ -1366,8 +1366,9 @@ lisa Sales</screen> </indexterm> <screen><command>nmblookup <replaceable>options netbios_name</replaceable></command></screen> <para>The <command>nmblookup</command> program resolves NetBIOS names into <systemitem class="protocol">IP</systemitem> addresses. The program broadcasts its query on the local subnet until the target machine replies.</para> - <para>Here is an example:</para> - <screen>~]$ <command>nmblookup trek</command> + <para>The following example displays the <systemitem class="protocol">IP</systemitem> address of the NetBIOS name <literal>trek</literal>:</para> + <screen> +<userinput>~]$ nmblookup trek</userinput> querying trek on 10.1.59.255 10.1.56.45 trek<00></screen>  @@ -1390,7 +1391,7 @@ querying trek on 10.1.59.255 <screen><command>pdbedit <replaceable>options</replaceable></command></screen> <para>The <command>pdbedit</command> program manages accounts located in the SAM database. All back ends are supported including <filename>smbpasswd</filename>, LDAP, and the <filename>tdb</filename> database library.</para> <para>The following are examples of adding, deleting, and listing users:</para> - <screen>~]$ <command>pdbedit -a kristin</command> + <screen>~]$ <command>pdbedit -a kristin</command> new password: retype new password: Unix username: kristin @@ -1412,7 +1413,7 @@ Kickoff time: Mon, 18 Jan 2038 22:14:07 GMT Password last set: Thu, 29 Jan 2004 08:29:28 GMT Password can change: Thu, 29 Jan 2004 08:29:28 GMT Password must change: Mon, 18 Jan 2038 22:14:07 GMT -<userinput>~]$ pdbedit -v -L kristin</userinput> +<userinput>~]$ pdbedit -v -L kristin</userinput> Unix username: kristin NT username: Account Flags: [U ] @@ -1567,8 +1568,8 @@ andriusb:505: lisa:504: kristin:506:</screen> <command>smbpasswd</command> program</primary> </indexterm> <screen><command>smbpasswd <replaceable>options username password</replaceable></command></screen> - <para>The <command>smbpasswd</command> program manages encrypted passwords. This program can be run by a superuser to change any user's password as well as by an ordinary user to change their own Samba password.</para>  + <para>The <command>smbpasswd</command> program manages encrypted passwords. This program can be run by a superuser to change any user's password and also by an ordinary user to change their own Samba password.</para> <bridgehead id="s3-samba-programs-smbspool"> <filename>smbspool</filename> </bridgehead> @@ -1643,9 +1644,9 @@ andriusb:505: lisa:504: kristin:506:</screen> <command>testparm</command> program</primary> </indexterm> <screen><command>testparm <replaceable>options filename hostname IP_address</replaceable></command></screen> - <para>The <command>testparm</command> program checks the syntax of the <filename>/etc/samba/smb.conf</filename> file. If your <filename>/etc/samba/smb.conf</filename> file is in the default location (<filename>/etc/samba/smb.conf</filename>) you do not need to specify the location. Specifying the hostname and IP address to the <command>testparm</command> program verifies that the <filename>hosts.allow</filename> and <filename>host.deny</filename> files are configured correctly. The <command>testparm</command> program also displays a summary of your <filename>/etc/samba/smb.conf</filename> file and the server's role (stand-alone, domain, etc.) after testing. This is convenient when debugging as it excludes comments and concisely presents information for experienced administrators to read.</para> + <para>The <command>testparm</command> program checks the syntax of the <filename>/etc/samba/smb.conf</filename> file. If your <filename>smb.conf</filename> file is in the default location (<filename>/etc/samba/smb.conf</filename>) you do not need to specify the location. Specifying the host name and <systemitem class="protocol">IP</systemitem> address to the <command>testparm</command> program verifies that the <filename>hosts.allow</filename> and <filename>host.deny</filename> files are configured correctly. The <command>testparm</command> program also displays a summary of your <filename>/etc/samba/smb.conf</filename> file and the server's role (stand-alone, domain, etc.) after testing. This is convenient when debugging as it excludes comments and concisely presents information for experienced administrators to read.</para> <para>For example:</para> - <screen>~]$ <command>testparm</command> + <screen>~]$ <command>testparm</command> Load smb config files from /etc/samba/smb.conf Processing section "[homes]" Processing section "[printers]"

9 years, 10 months

1
0
0 / 0

[system-administrators-guide] Updating modinfo e1000e example

by stephenw

commit 717356dcf513cc160df6ce5dd1097a16fb199d36 Author: Stephen Wadeley <swadeley(a)redhat.com> Date: Wed Aug 6 23:21:35 2014 +0200 Updating modinfo e1000e example en-US/Working_with_Kernel_Modules.xml | 17 +++++++++++------ 1 files changed, 11 insertions(+), 6 deletions(-) --- diff --git a/en-US/Working_with_Kernel_Modules.xml b/en-US/Working_with_Kernel_Modules.xml index b89ae9e..3fb7b2b 100644 --- a/en-US/Working_with_Kernel_Modules.xml +++ b/en-US/Working_with_Kernel_Modules.xml @@ -151,18 +151,23 @@ kvm 253162 1 kvm_intel <title>Listing information about a kernel module with lsmod</title> <para>To display information about the <systemitem class="resource">e1000e</systemitem> module, which is the Intel PRO/1000 network driver, run:</para> <screen>~]# <command>modinfo e1000e</command> -filename: /lib/modules/2.6.32-71.el6.x86_64/kernel/drivers/net/e1000e/e1000e.ko -version: 1.2.7-k2 +filename: /lib/modules/3.15.6-200.fc20.x86_64/kernel/drivers/net/ethernet/intel/e1000e/e1000e.ko +version: 2.3.2-k license: GPL description: Intel(R) PRO/1000 Network Driver author: Intel Corporation, <linux.nics(a)intel.com> -srcversion: 93CB73D3995B501872B2982 +srcversion: AB1D5F954DC03B1296E61BD alias: pci:v00008086d00001503sv*sd*bc*sc*i* alias: pci:v00008086d00001502sv*sd*bc*sc*i* <lineannotation>[some <literal>alias</literal> lines omitted]</lineannotation> alias: pci:v00008086d0000105Esv*sd*bc*sc*i* -depends: -vermagic: 2.6.32-71.el6.x86_64 SMP mod_unload modversions +depends: ptp +intree: Y +vermagic: 3.15.6-200.fc20.x86_64 SMP mod_unload +signer: Fedora kernel signing key +sig_key: 5B:F5:46:43:B9:B1:61:72:B2:43:6D:40:A5:6F:75:0A:D1:58:1D:80 +sig_hashalgo: sha256 +parm: debug:Debug level (0=none,...,16=all) (int) parm: copybreak:Maximum size of packet that is copied to a new buffer on receive (uint) parm: TxIntDelay:Transmit Interrupt Delay (array of int) parm: TxAbsIntDelay:Transmit Absolute Interrupt Delay (array of int) @@ -174,7 +179,7 @@ parm: SmartPowerDownEnable:Enable PHY smart power down (array of int) parm: KumeranLockLoss:Enable Kumeran lock loss workaround (array of int) parm: WriteProtectNVM:Write-protect NVM [WARNING: disabling this can lead to corrupted NVM] (array of int) parm: CrcStripping:Enable CRC Stripping, disable if your BMC needs the CRC (array of int) -parm: EEE:Enable/disable on parts that support the feature (array of int)</screen> +</screen> </example> <variablelist> <para>Here are descriptions of a few of the fields in <command>modinfo</command> output:</para>

9 years, 10 months

1
0
0 / 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

docs-commits August 2014