NetBSD Problem Report #41913

From jruohone@gmail.com  Fri Aug 21 05:28:05 2009
Return-Path: <jruohone@gmail.com>
Received: from mail.netbsd.org (mail.netbsd.org [204.152.190.11])
	by www.NetBSD.org (Postfix) with ESMTP id DBD2C63BDF9
	for <gnats-bugs@gnats.netbsd.org>; Fri, 21 Aug 2009 05:28:04 +0000 (UTC)
Message-Id: <20090821052051.B0DF014471@marx.bitnet>
Date: Fri, 21 Aug 2009 08:20:51 +0300 (EEST)
From: Jukka Ruohonen <jruohonen@iki.fi>
Sender: a b <jruohone@gmail.com>
Reply-To: jruohonen@iki.fi
To: gnats-bugs@gnats.NetBSD.org
Subject: The man-page rc.conf(5) misses variables
X-Send-Pr-Version: 3.95

>Number:         41913
>Category:       misc
>Synopsis:       The man-page rc.conf(5) misses variables
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri Aug 21 05:30:00 +0000 2009
>Closed-Date:    Fri Mar 19 19:21:34 +0000 2010
>Last-Modified:  Fri Mar 19 19:35:01 +0000 2010
>Originator:     Jukka Ruohonen
>Release:        NetBSD 5.0_STABLE
>Organization:
>Environment:
irrelevant
>Description:

By comparing the file /etc/defaults/rc.conf and the manual page
rc.conf(5), one can observe that the following variables are present in the
former but not in the latter:

- ccd
- cgd
- raidframe
- quota
- ldconfig
- sysdb
- rtclocaltime
- ftp_proxy
- identd
- ftpd
- iscsi_target
- envsys
- wdogctl

It would be nice if at least the generic variables (cf. ldconfig, sysdb,
rtclocaltime, etc.) would be documented.

>How-To-Repeat:

man rc.conf(5)

>Fix:

Writing time.

>Release-Note:

>Audit-Trail:
From: Jukka Ruohonen <jruohonen@iki.fi>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/41913
Date: Tue, 22 Sep 2009 22:16:17 +0300

 Here is a draft that documents the mentioned variables.


 Index: src/share/man/man5/rc.conf.5
 ===================================================================
 RCS file: /cvsroot/src/share/man/man5/rc.conf.5,v
 retrieving revision 1.136
 diff -u -p -r1.136 rc.conf.5
 --- src/share/man/man5/rc.conf.5	14 Sep 2009 12:37:08 -0000	1.136
 +++ src/share/man/man5/rc.conf.5	22 Sep 2009 19:12:15 -0000
 @@ -334,9 +334,23 @@ Enables process accounting with
  Requires
  .Pa /var/account/acct
  to exist.
 +.It Sy ccd
 +Boolean value.
 +Configures concatenated disk devices according to
 +.Xr ccd.conf 5 .
 +.It Sy cgd
 +Boolean value.
 +Configures cryptographic disk devices.
 +Requires
 +.Pa /etc/cgd/cgd.conf .
 +See
 +.Xr cgdconfig 8
 +for additional details.
  .It Sy clear_tmp
  Boolean value.
 -Clear /tmp after reboot.
 +Clear
 +.Pa /tmp
 +after reboot.
  .It Sy dmesg
  Boolean value.
  Create
 @@ -345,13 +359,26 @@ from the output of
  .Xr dmesg 8 .
  Passes
  .Sy dmesg_flags .
 +.It Sy envsys
 +Boolean value.
 +Sets preferences for the environmental systems framework,
 +.Xr envsys 4 .
 +Requires
 +.Pa /etc/envsys.conf ,
 +which is described in
 +.Xr envsys.conf 5 .
  .It Sy gpio
  Boolean value.
  Configure
  .Xr gpio 4
 -devices .
 +devices.
  See
  .Xr gpio.conf 5 .
 +.It Sy ldconfig
 +Boolean value.
 +Configures
 +.Xr a.out 5
 +runtime link editor directory cache.
  .It Sy mixerctl
  Boolean value.
  Read
 @@ -379,6 +406,19 @@ can be used to override the default loca
  .Dq real
  temporary directories,
  .Dq Pa /private/tmp .
 +.It Sy quota
 +Boolean value.
 +Checks and enables quotas by running
 +.Xr quotacheck 1
 +and
 +.Xr quotaon 8 .
 +.It Sy raidframe
 +Boolean value.
 +Configures
 +.Xr raid 4 ,
 +RAIDframe disk devices. See
 +.Xr raidctl 8
 +for additional details.
  .It Sy rndctl
  Boolean value.
  Runs the
 @@ -426,6 +466,15 @@ the following commands will be executed:
  .Li "rndctl -c -e -d wd1" ;
  .Li "rndctl -c -e -t tty" ;
  .Li "rndctl -c -t net" .
 +.It Sy rtclocaltime
 +Boolean value.
 +Sets the real time clock to local time by adjusting the
 +.Xr sysctl 7
 +value of
 +.Pa kern.rtc_offset .
 +The offset from UTC is calculated automatically according
 +to the time zone information in the file
 +.Pa /etc/localtime .
  .It Sy savecore
  Boolean value.
  Runs the
 @@ -437,6 +486,15 @@ The directory where crash dumps are stor
  .Sy savecore_dir .
  The default setting is
  .Dq Pa /var/crash .
 +.It Sy sysdb
 +Boolean value.
 +Builds various system databases, including
 +.Pa /var/run/dev.db ,
 +.Pa /etc/spwd.db ,
 +.Pa /var/db/netgroup.db ,
 +.Pa /var/db/services.db ,
 +and entries for
 +.Xr utmp 5 .
  .It Sy tpctl
  Boolean value.
  Run
 @@ -466,6 +524,14 @@ Send notification mail to users if any r
  Read
  .Xr virecover 8
  for more information.
 +.It Sy wdogctl
 +Boolean value.
 +Configures watchdog timers.
 +Passes
 +.Sy wdogctl_flags .
 +Refer to
 +.Xr wdogctl 8
 +for information on how to configure a timer.
  .El
  .Ss System security setting
  .Bl -tag -width net_interfaces
 @@ -584,6 +650,11 @@ Boolean value.
  Flushes the route table on networking startup.
  Useful when coming up to multiuser mode after going down to
  single-user mode.
 +.It Sy ftp_proxy
 +Boolean value.
 +Runs
 +.Xr ftp-proxy 8 ,
 +the proxy daemon for the Internet File Transfer Protocol.
  .It Sy hostapd
  Boolean value.
  Runs
 @@ -867,6 +938,11 @@ Passes
  Boolean value.
  Run
  .Xr cron 8 .
 +.It Sy ftpd
 +Runs the
 +.Xr ftpd 8
 +daemon and passes
 +.Sy ftpd_flags .
  .It Sy httpd
  Boolean value.
  Runs the
 @@ -1276,6 +1352,19 @@ Passes
  .El
  .Ss Other daemons
  .Bl -tag -width net_interfaces
 +.It Sy identd
 +Boolean value.
 +Runs
 +.Xr identd 8 ,
 +the daemon for the user identification protocol.
 +Passes
 +.Sy identd_flags .
 +.It Sy iscsi_target
 +Boolean value.
 +Runs the server for iSCSI requests,
 +.Xr iscsi-target 8 .
 +Passes
 +.Sy iscsi_target_flags .
  .It Sy isdnd
  Boolean value.
  Runs

State-Changed-From-To: open->closed
State-Changed-By: jruoho@NetBSD.org
State-Changed-When: Fri, 19 Mar 2010 19:21:34 +0000
State-Changed-Why:
Fixed in rev. 1.139.


From: Jukka Ruohonen <jruoho@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/41913 CVS commit: src/share/man/man5
Date: Fri, 19 Mar 2010 19:17:55 +0000

 Module Name:	src
 Committed By:	jruoho
 Date:		Fri Mar 19 19:17:54 UTC 2010

 Modified Files:
 	src/share/man/man5: rc.conf.5

 Log Message:
 Document some missing options. Fixes my own PR # 41913.


 To generate a diff of this commit:
 cvs rdiff -u -r1.138 -r1.139 src/share/man/man5/rc.conf.5

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

>Unformatted:

Home	PR Database Search