Date: Tue, 30 Oct 2001 15:50:14 +0000 From: setantae <setantae@submonkey.net> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/31640: Avoiding uppercase program names in manpages Message-ID: <E15yb9a-0006LN-00@rhadamanth.private.submonkey.net>
next in thread | raw e-mail | index | archive | help
>Number: 31640
>Category: docs
>Synopsis: Avoiding uppercase program names in manpages
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: sw-bug
>Submitter-Id: current-users
>Arrival-Date: Tue Oct 30 08:00:01 PST 2001
>Closed-Date:
>Last-Modified:
>Originator: setantae@submonkey.net
>Release: FreeBSD 4.4-STABLE i386
>Organization:
>Environment:
System: FreeBSD rhadamanth.private.submonkey.net 4.4-STABLE FreeBSD 4.4-STABLE #0: Fri Oct 26 20:03:42 BST 2001 root@rhadaman
th.private.submonkey.net:/usr/obj/usr/src/sys/RHADAMANTH i386
>Description:
In many manpages, there are a number of program names that appear with
uppercased first letters when the program name starts the sentence.
Other manpages treat this situation differently and stick to the lower
case variant.
Since which of these approaches is correct seems to be a religious issue,
the following patch updates the manpages for /bin (with the exception of
ed(1) and pax(1) which require more time than I have available right now)
to skirt around this issue.
>How-To-Repeat:
>Fix:
Apply the following patch to /bin (from /usr/src) :
diff -urN bin.old/chio/chio.1 bin/chio/chio.1
--- bin.old/chio/chio.1 Thu Aug 16 11:01:03 2001
+++ bin/chio/chio.1 Tue Oct 30 14:54:42 2001
@@ -47,9 +47,10 @@
.Ar arg2
.Op Ar arg3 Op ...
.Sh DESCRIPTION
+The
.Nm
-is used to control the operation of medium changers, such as those found
-in tape and optical disk jukeboxes.
+utility is used to control the operation of medium changers, such as those
+found in tape and optical disk jukeboxes.
.Pp
The options are as follows:
.Bl -tag -width indent
diff -urN bin.old/domainname/domainname.1 bin/domainname/domainname.1
--- bin.old/domainname/domainname.1 Thu Aug 16 11:01:04 2001
+++ bin/domainname/domainname.1 Tue Oct 30 14:55:10 2001
@@ -42,8 +42,9 @@
.Nm
.Op Ar ypdomain
.Sh DESCRIPTION
-.Nm Domainname
-prints the name of the current YP/NIS domain. The super-user can
+The
+.Nm
+utility prints the name of the current YP/NIS domain. The super-user can
set the domain name by supplying an argument; this is usually done in the
network initialization script
.Pa /etc/rc.network ,
diff -urN bin.old/hostname/hostname.1 bin/hostname/hostname.1
--- bin.old/hostname/hostname.1 Thu Aug 16 11:01:05 2001
+++ bin/hostname/hostname.1 Tue Oct 30 15:01:33 2001
@@ -43,8 +43,9 @@
.Op Fl s
.Op Ar name-of-host
.Sh DESCRIPTION
-.Nm Hostname
-prints the name of the current host. The super-user can
+The
+.Nm
+command prints the name of the current host. The super-user can
set the hostname by supplying an argument; this is usually done in the
network initialization script
.Pa /etc/rc.network ,
diff -urN bin.old/mkdir/mkdir.1 bin/mkdir/mkdir.1
--- bin.old/mkdir/mkdir.1 Thu Aug 16 11:01:06 2001
+++ bin/mkdir/mkdir.1 Tue Oct 30 15:03:37 2001
@@ -47,8 +47,9 @@
.Op Fl m Ar mode
.Ar directory_name ...
.Sh DESCRIPTION
-.Nm Mkdir
-creates the directories named as operands, in the order specified,
+The
+.Nm
+utility creates the directories named as operands, in the order specified,
using mode
.Li rwxrwxrwx (\&0777)
as modified by the current
diff -urN bin.old/pwd/pwd.1 bin/pwd/pwd.1
--- bin.old/pwd/pwd.1 Thu Aug 16 11:01:07 2001
+++ bin/pwd/pwd.1 Tue Oct 30 15:04:09 2001
@@ -44,8 +44,9 @@
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
-.Nm Pwd
-writes the absolute pathname of the current working directory to
+The
+.Nm
+command writes the absolute pathname of the current working directory to
the standard output.
.Pp
Some shells may provide a builtin
diff -urN bin.old/pwd/realpath.1 bin/pwd/realpath.1
--- bin.old/pwd/realpath.1 Thu Aug 16 11:01:07 2001
+++ bin/pwd/realpath.1 Tue Oct 30 15:06:11 2001
@@ -46,8 +46,9 @@
.Nm
.Ar path
.Sh DESCRIPTION
+The
.Nm
-uses the
+command uses the
.Xr realpath 3
function to resolve all symbolic links, extra
.Ql /
diff -urN bin.old/rcp/rcp.1 bin/rcp/rcp.1
--- bin.old/rcp/rcp.1 Thu Aug 16 11:01:07 2001
+++ bin/rcp/rcp.1 Tue Oct 30 15:09:44 2001
@@ -49,8 +49,9 @@
.Ar
.Ar directory
.Sh DESCRIPTION
-.Nm Rcp
-copies files between machines. Each
+The
+.Nm
+command copies files between machines. Each
.Ar file
or
.Ar directory
@@ -113,13 +114,13 @@
on a remote host may be quoted (using \e, ", or \(aa)
so that the metacharacters are interpreted remotely.
.Pp
-.Nm Rcp
-does not prompt for passwords; it performs remote execution
+This command does not prompt for passwords; it performs remote execution
via
.Xr rsh 1 ,
and requires the same authorization.
.Pp
-.Nm Rcp
+In addition,
+.Nm
handles third party copies, where neither source nor target files
are on the current machine.
.Sh FILES
diff -urN bin.old/sync/sync.8 bin/sync/sync.8
--- bin.old/sync/sync.8 Thu Aug 16 11:01:10 2001
+++ bin/sync/sync.8 Tue Oct 30 15:07:50 2001
@@ -41,9 +41,10 @@
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
-.Nm Sync
-can be called to ensure that all disk writes have been completed before the
-processor is halted in a way not suitably done by
+The
+.Nm
+command can be called to ensure that all disk writes have been completed
+before the processor is halted in a way not suitably done by
.Xr reboot 8
or
.Xr halt 8 .
@@ -57,8 +58,9 @@
and flushing internal caches before performing a final
.Nm .
.Pp
-.Nm Sync
-utilizes the
+The
+.Nm
+command utilizes the
.Xr sync 2
function call.
.Sh SEE ALSO
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?E15yb9a-0006LN-00>