docs/85066: [patch] builtin(1) manpage has incomplete SYNOPSIS section

Gary W. Swearingen garys at opusnet.com
Wed Aug 17 23:50:37 UTC 2005


>Number:         85066
>Category:       docs
>Synopsis:       [patch] builtin(1) manpage has incomplete SYNOPSIS section
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Aug 17 23:50:18 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 5.4-RELEASE i386
>Organization:
none
>Environment:
n/a
>Description:

The builtin(1) manpage covers MANY commands but has a synopsis for
only "builtin" (but no description of "builtin" command).

>How-To-Repeat:
n/a

>Fix:
Remove the SYNOPSIS section.

(An alternative would be to replace the "builtin" synopsis with
a "See the built-in command description in the appropriate shell
manual page.".)

--- builtin..orig.1	Tue Aug  9 10:22:33 2005
+++ builtin.1	Tue Aug  9 10:22:48 2005
@@ -128,10 +128,6 @@
 .Nm which ,
 .Nm while
 .Nd shell builtin commands
-.Sh SYNOPSIS
-.Nm
-.Op Fl options
-.Op Ar args ...
 .Sh DESCRIPTION
 Shell builtin commands are commands that can be executed within the
 running shell's process.


>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list