From mheinen0@wiesbaden-online.de  Thu Aug  9 09:00:59 2001
Return-Path: <mheinen0@wiesbaden-online.de>
Received: from mail.rhein-zeitung.de (mail.rhein-zeitung.DE [195.189.135.96])
	by hub.freebsd.org (Postfix) with ESMTP id 1340837B403
	for <FreeBSD-gnats-submit@freebsd.org>; Thu,  9 Aug 2001 09:00:57 -0700 (PDT)
	(envelope-from mheinen0@wiesbaden-online.de)
Received: from Moses.earth.sol (pppin209.max-mainz.rz-online.NET [212.7.164.209])
	by mail.rhein-zeitung.de (8.11.0/8.11.0) with ESMTP id f79G0qY08330
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 9 Aug 2001 18:00:52 +0200
Received: (from vincent@localhost)
	by Moses.earth.sol (8.11.4/8.11.3) id f79G0nr89849;
	Thu, 9 Aug 2001 18:00:50 +0200 (CEST)
	(envelope-from vincent)
Message-Id: <200108091600.f79G0nr89849@Moses.earth.sol>
Date: Thu, 9 Aug 2001 18:00:50 +0200 (CEST)
From: Martin Heinen <mheinen0@wiesbaden-online.de>
Reply-To: Martin Heinen <mheinen0@wiesbaden-online.de>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Mark Up changes for chapter Configuration and Tuning
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         29570
>Category:       docs
>Synopsis:       Mark Up changes for chapter Configuration and Tuning
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Aug 09 09:10:01 PDT 2001
>Closed-Date:    Sat Aug 11 13:25:49 PDT 2001
>Last-Modified:  Sat Aug 11 13:30:01 PDT 2001
>Originator:     Martin Heinen
>Release:        FreeBSD 4.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD Moses.earth.sol 4.3-STABLE FreeBSD 4.3-STABLE #0: Fri Jul 20 00:11:52 CEST 2001 toor@Moses.earth.sol:/usr/obj/usr/src/sys/MOSES i386


	
>Description:
	
	additional files marked up with <filename>,
	replaced literal " with <quote>,
	marked up root as user,
	changed fxp0 to show up as device,
	replaced bind with &man.named.8;,
	marked up syslog, ppp as <command>
>How-To-Repeat:
	read the Chapter 'Configuration and Tuning'
>Fix:

	RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
	retrieving revision 1.12
	diff -r1.12 chapter.sgml
	158,159c158,159
	< 	partition and be done with it?  Then I don't have to worry
	< 	about undersizing things!</para>
	---
	> 	  partition and be done with it?  Then I don't have to worry
	> 	  about undersizing things!</para>
	244c244,245
	<       or 'make world' will not overwrite the <filename>rc.conf</filename>
	---
	>       or <command>make world</command> will not overwrite the 
	>       <filename>rc.conf</filename>
	267c268,269
	<       identified with a ".default" suffix.  If there are no existing
	---
	>       identified with a <quote>.default</quote> suffix.  If there 
	>       are no existing
	285,287c287,289
	<     <para>It can be quickly seen that only the srm.conf file has been
	<       changed.  A later update of the apache port would not overwrite
	<       this changed file.</para>
	---
	>     <para>It can be quickly seen that only the <filename>srm.conf</filename>
	>       file has been changed.  A later update of the apache port would not
	>       overwrite this changed file.</para>
	305,308c307,313
	<       system startup with a 'start' argument, and at system shutdown
	<       with a 'stop' argument.  This is the recommended way for
	<       starting system-wide services that are to be run as root, or that
	<       expect to be started as root.  These scripts are registered as
	---
	>       system startup with a <option>start</option> argument, and at
	>       system shutdown with a <option>stop</option> argument.
	>       This is the recommended way for
	>       starting system-wide services that are to be run as
	>       <username>root</username>, or that
	>       expect to be started as <username>root</username>.
	>       These scripts are registered as
	364c369
	<       and maintained by non-root users.</para>
	---
	>       and maintained by non-<username>root</username> users.</para>
	367c372,373
	<       time specification may be replaced by '@reboot', which will
	---
	>       time specification may be replaced by <literal>@reboot</literal>,
	>       which will
	383,384c389,391
	<     <para>A given network interface has one "real" address, and may
	<       have any number of "alias" addresses.  These aliases are
	---
	>     <para>A given network interface has one <quote>real</quote> address,
	>       and may have any number of <quote>alias</quote> addresses.
	>       These aliases are
	388c395,396
	<     <para>An alias entry for the interface 'fxp0' looks like:</para>
	---
	>     <para>An alias entry for the interface <devicename>fxp0</devicename>
	>       looks like:</para>
	403c411,412
	<     <para>For example, consider the case where the fxp0 interface is
	---
	>     <para>For example, consider the case where the 
	>       <devicename>fxp0</devicename> interface is
	446,447c455,456
	< 	      <entry>Extra sendmail configuration, other MTA configuration 
	< 		files.
	---
	> 	      <entry>Extra &man.sendmail.8; configuration, other 
	> 		MTA configuration files.
	452c461,462
	< 	      <entry>Configuration for both user- and kernel-ppp programs.
	---
	> 	      <entry>Configuration for both user- and
	> 	        kernel-<command>ppp</command> programs.
	457c467
	< 	      <entry>Default location for bind(8) data.  Normally the
	---
	> 	      <entry>Default location for &man.named.8; data.  Normally the
	472,473c482,483
	< 	      <entry>Persistent system-specific data files, such as bind zone 
	< 		files, database files, and so on.</entry>
	---
	> 	      <entry>Persistent system-specific data files, such as 
	> 		&man.named.8; zone files, database files, and so on.</entry>
	602c612,613
	< 	  of syslog messages are logged to particular log files.</para>
	---
	> 	  of <command>syslog</command> messages are logged to particular
	> 	  log files.</para>
	653,654c664,665
	< 	  causing them to be named: logfile.0.gz, logfile.1.gz, and so
	< 	  on.</para>
	---
	> 	  causing them to be named: <filename>logfile.0.gz</filename>,
	> 	  <filename>logfile.1.gz</filename>, and so on.</para>
>Release-Note:
>Audit-Trail:

From: Dima Dorfman <dima@unixfreak.org>
To: Martin Heinen <mheinen0@wiesbaden-online.de>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/29570: Mark Up changes for chapter Configuration and Tuning 
Date: Thu, 09 Aug 2001 10:28:47 -0700

 Martin Heinen <mheinen0@wiesbaden-online.de> writes:
 > >Description:
 > 	
 > 	additional files marked up with <filename>,
 > 	replaced literal " with <quote>,
 > 	marked up root as user,
 > 	changed fxp0 to show up as device,
 > 	replaced bind with &man.named.8;,
 > 	marked up syslog, ppp as <command>
 
 Great!  Put please submit this in the form of a unified diff, and
 don't indent it.  The former will make it easier to read, and the
 latter will make it possible to apply.
 
 Thanks.

From: Martin Heinen <mheinen0@wiesbaden-online.de>
To: Dima Dorfman <dima@unixfreak.org>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/29570: Mark Up changes for chapter Configuration and Tuning
Date: Fri, 10 Aug 2001 12:52:10 +0200

 --82I3+IH0IqGh5yIs
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 
 On Thu, Aug 09, 2001 at 10:28:47AM -0700, Dima Dorfman wrote:
 
 > Great!  Put please submit this in the form of a unified diff, and
 > don't indent it.  The former will make it easier to read, and the
 > latter will make it possible to apply.
 
 Sorry for the inconvenience, I attached a unified diff against
 1.13.
 
 Martin
 
 -- 
 Marxpitn
 
 --82I3+IH0IqGh5yIs
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: attachment; filename=ch-udiff
 
 Index: chapter.sgml
 ===================================================================
 RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
 retrieving revision 1.13
 diff -u -r1.13 chapter.sgml
 --- chapter.sgml	2001/08/09 23:42:29	1.13
 +++ chapter.sgml	2001/08/10 10:41:22
 @@ -159,8 +159,8 @@
  	<title>Why Partition?</title>
  
  	<para> Why partition at all?  Why not create one big root
 -	partition and be done with it?  Then I don't have to worry
 -	about undersizing things!</para>
 +	  partition and be done with it?  Then I don't have to worry
 +	  about undersizing things!</para>
  
  	<para>There are several reasons this is not a good idea.
  	  First, each partition has different operational
 @@ -245,7 +245,8 @@
        unique.</para>
  
      <para>Upgrading the system using &man.sysinstall.8;
 -      or 'make world' will not overwrite the <filename>rc.conf</filename>
 +      or <command>make world</command> will not overwrite the 
 +      <filename>rc.conf</filename>
        file, so system configuration information will not be lost.</para>
  
    </sect1>
 @@ -268,7 +269,8 @@
  
      <para>Normally, when a port or package is installed, sample
        configuration files are also installed.  These are usually
 -      identified with a ".default" suffix.  If there are no existing
 +      identified with a <quote>.default</quote> suffix.  If there 
 +      are no existing
        configuration files for the application, they will be created by
        copying the .default files.</para>
  
 @@ -286,9 +288,9 @@
  -rw-r--r--  1 root  wheel   7980 May 20  1998 srm.conf
  -rw-r--r--  1 root  wheel   7933 May 20  1998 srm.conf.default</literallayout>
  
 -    <para>It can be quickly seen that only the srm.conf file has been
 -      changed.  A later update of the apache port would not overwrite
 -      this changed file.</para>
 +    <para>It can be quickly seen that only the <filename>srm.conf</filename>
 +      file has been changed.  A later update of the apache port would not
 +      overwrite this changed file.</para>
  
    </sect1>
  
 @@ -306,10 +308,13 @@
      <para>Software installed from a port or the packages collection
        will often place a script in
        <filename>/usr/local/etc/rc.d</filename> which is invoked at
 -      system startup with a 'start' argument, and at system shutdown
 -      with a 'stop' argument.  This is the recommended way for
 -      starting system-wide services that are to be run as root, or that
 -      expect to be started as root.  These scripts are registered as
 +      system startup with a <option>start</option> argument, and at
 +      system shutdown with a <option>stop</option> argument.
 +      This is the recommended way for
 +      starting system-wide services that are to be run as
 +      <username>root</username>, or that
 +      expect to be started as <username>root</username>.
 +      These scripts are registered as
        part of the installation of the package, and will be removed
        when the package is removed.</para>
  
 @@ -365,10 +370,11 @@
        system services.  This approach has a number of advantages, not
        least being that because &man.cron.8; runs these processes as the
        owner of the <command>crontab</command>, services may be started
 -      and maintained by non-root users.</para>
 +      and maintained by non-<username>root</username> users.</para>
      
      <para>This takes advantage of an undocumented feature of &man.cron.8; the
 -      time specification may be replaced by '@reboot', which will
 +      time specification may be replaced by <literal>@reboot</literal>,
 +      which will
        cause the job to be run when &man.cron.8; is started shortly after
        system boot.</para>
    </sect1>
 @@ -384,12 +390,14 @@
        achieved by assigning multiple network addresses to a single
        interface.</para>
  
 -    <para>A given network interface has one "real" address, and may
 -      have any number of "alias" addresses.  These aliases are
 +    <para>A given network interface has one <quote>real</quote> address,
 +      and may have any number of <quote>alias</quote> addresses.
 +      These aliases are
        normally added by placing alias entries in
        <filename>/etc/rc.conf</filename>.</para>
  
 -    <para>An alias entry for the interface 'fxp0' looks like:</para>
 +    <para>An alias entry for the interface <devicename>fxp0</devicename>
 +      looks like:</para>
  
  <programlisting>ifconfig_fxp0_alias0="inet xxx.xxx.xxx.xxx netmask xxx.xxx.xxx.xxx"</programlisting>
  
 @@ -404,7 +412,8 @@
        Any other addresses which fall within this network must have a
        netmask of all 1's.</para>
  
 -    <para>For example, consider the case where the fxp0 interface is
 +    <para>For example, consider the case where the 
 +      <devicename>fxp0</devicename> interface is
        connected to two networks, the 10.1.1.0 network with a netmask
        of 255.255.255.0 and the 202.0.75.16 network with a netmask of
        255.255.255.240.  We want the system to appear at 10.1.1.1
 @@ -447,18 +456,19 @@
  	    </row>
  	    <row>
  	      <entry><filename>/etc/mail</filename></entry>
 -	      <entry>Extra sendmail configuration, other MTA configuration 
 -		files.
 +	      <entry>Extra &man.sendmail.8; configuration, other 
 +		MTA configuration files.
  	      </entry>
  	    </row>
  	    <row>
  	      <entry><filename>/etc/ppp</filename></entry>
 -	      <entry>Configuration for both user- and kernel-ppp programs.
 +	      <entry>Configuration for both user- and
 +	        kernel-<command>ppp</command> programs.
  	      </entry>
  	    </row>
  	    <row>
  	      <entry><filename>/etc/namedb</filename></entry>
 -	      <entry>Default location for bind(8) data.  Normally the
 +	      <entry>Default location for &man.named.8; data.  Normally the
  		boot file is located here, and contains a directive to
  		refer to other data in <filename>/var/db</filename>.</entry>
  	    </row>
 @@ -473,8 +483,8 @@
  	    </row>
  	    <row>
  	      <entry><filename>/var/db</filename></entry>
 -	      <entry>Persistent system-specific data files, such as bind zone 
 -		files, database files, and so on.</entry>
 +	      <entry>Persistent system-specific data files, such as 
 +		&man.named.8; zone files, database files, and so on.</entry>
  	    </row>
  	  </tbody>
  	</tgroup>
 @@ -603,7 +613,8 @@
  	
  	<para><filename>syslog.conf</filename> is the configuration file
  	  for the &man.syslogd.8; program.  It indicates which types
 -	  of syslog messages are logged to particular log files.</para>
 +	  of <command>syslog</command> messages are logged to particular
 +	  log files.</para>
  
  	<programlisting># $FreeBSD&dollar;
  #
 @@ -654,8 +665,8 @@
  	  <filename>logfile.1</filename>, <filename>logfile.1</filename>
  	  is moved to <filename>logfile.2</filename>, and so on.
  	  Additionally, the log files may be archived in &man.gzip.1; format
 -	  causing them to be named: logfile.0.gz, logfile.1.gz, and so
 -	  on.</para>
 +	  causing them to be named: <filename>logfile.0.gz</filename>,
 +	  <filename>logfile.1.gz</filename>, and so on.</para>
  
  	<para><filename>newsyslog.conf</filename> indicates which log
  	  files are to be managed, how many are to be kept, and when
 @@ -743,8 +754,9 @@
      <screen>&prompt.root; <userinput>sysctl kern.maxfiles=5000</userinput>
  kern.maxfiles: 2088 -> 5000</screen>
  
 -    <para>Settings of sysctl variables are usually either strings, numbers,
 -      or booleans.  A boolean being 1 for yes or a 0 for no.</para>
 +    <para>Settings of &man.sysctl.8; variables are usually either strings,
 +      numbers, or booleans.  A boolean being <literal>1</literal> for yes
 +      or a <literal>0</literal> for no.</para>
    </sect1>
  
    <sect1 id="configtuning-disk">
 
 --82I3+IH0IqGh5yIs--
State-Changed-From-To: open->closed 
State-Changed-By: dd 
State-Changed-When: Sat Aug 11 13:25:49 PDT 2001 
State-Changed-Why:  
Applied, thanks! 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=29570 

From: Dima Dorfman <dima@unixfreak.org>
To: Martin Heinen <mheinen0@wiesbaden-online.de>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/29570: Mark Up changes for chapter Configuration and Tuning 
Date: Sat, 11 Aug 2001 13:23:11 -0700

 Martin Heinen <mheinen0@wiesbaden-online.de> writes:
 >  	    <row>
 >  	      <entry><filename>/etc/ppp</filename></entry>
 > -	      <entry>Configuration for both user- and kernel-ppp programs.
 > +	      <entry>Configuration for both user- and
 > +	        kernel-<command>ppp</command> programs.
 >  	      </entry>
 
 This isn't right, because it isn't talking about ppp(8) specifically.
 
 > @@ -743,8 +754,9 @@
 >      <screen>&prompt.root; <userinput>sysctl kern.maxfiles=5000</userinput>
 >  kern.maxfiles: 2088 -> 5000</screen>
 >  
 > -    <para>Settings of sysctl variables are usually either strings, numbers,
 > -      or booleans.  A boolean being 1 for yes or a 0 for no.</para>
 > +    <para>Settings of &man.sysctl.8; variables are usually either strings,
 
 Changing sysctl -> sysctl.8 seems wrong, since that command isn't the
 only way to set sysctl variables.  Besides, there's concern with
 overusing the man page entities.
 
 Other than that, the patch looks good.  I'll apply it shortly.
>Unformatted:
