Date: Sat, 27 Jul 2002 15:38:25 +0200 (CEST) From: Martin Heinen <martin@sumuk.de> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/41049: [PATCH] cleanup of <userinput> elements Message-ID: <200207271338.g6RDcPt5006632@Kain.sumuk.de>
next in thread | raw e-mail | index | archive | help
>Number: 41049
>Category: docs
>Synopsis: [PATCH] cleanup of <userinput> elements
>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: Sat Jul 27 06:40:01 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator: Martin Heinen
>Release: FreeBSD 4.6-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD Kain.sumuk.de 4.6-PRERELEASE FreeBSD 4.6-PRERELEASE #0: Sun May 12 20:01:38 CEST 2002 toor@Kain.sumuk.de:/usr/obj/usr/src/sys/KAIN i386
>Description:
Following revision 1.92 of disks/chapter.sgml cleanup
<userinput> elements in the books of the Documentation Project.
>How-To-Repeat:
>Fix:
Index: books/faq/book.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/faq/book.sgml,v
retrieving revision 1.461
diff -u -r1.461 book.sgml
--- books/faq/book.sgml 22 Jul 2002 14:10:07 -0000 1.461
+++ books/faq/book.sgml 27 Jul 2002 13:11:15 -0000
@@ -4984,7 +4984,7 @@
that will update installed ports to the latest version in
the ports tree.</para>
- <screen>&prompt.root; <userinput>pkg_version <option>-c</option> > <replaceable>/tmp/myscript</replaceable></userinput></screen>
+ <screen>&prompt.root; <userinput>pkg_version -c > <replaceable>/tmp/myscript</replaceable></userinput></screen>
<para>The output script <emphasis>must</emphasis> be edited by
hand before you use it. Current versions of
@@ -6075,7 +6075,7 @@
<para>Unmounting the device is simple:</para>
- <screen>&prompt.user; <userinput>umount <filename>~/my-mount-point</></userinput></screen>
+ <screen>&prompt.user; <userinput>umount ~/my-mount-point</userinput></screen>
<para>Enabling <varname>vfs.usermount</varname>, however, has
negative security implications. A better way to access MSDOS
Index: books/handbook/cutting-edge/chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml,v
retrieving revision 1.134
diff -u -r1.134 chapter.sgml
--- books/handbook/cutting-edge/chapter.sgml 16 Jul 2002 02:11:35 -0000 1.134
+++ books/handbook/cutting-edge/chapter.sgml 27 Jul 2002 13:13:58 -0000
@@ -867,7 +867,7 @@
<para>The general format of the command line you will type is as
follows:</para>
- <screen>&prompt.root; <userinput>make <option>-<replaceable/x/</option> <option>-D<replaceable>VARIABLE</replaceable></option> <replaceable>target</replaceable></userinput></screen>
+ <screen>&prompt.root; <userinput>make -<replaceable/x/ -D<replaceable>VARIABLE</replaceable> <replaceable>target</replaceable></userinput></screen>
<para>In this example, <option>-<replaceable>x</replaceable></option>
is an option that you would pass to &man.make.1;. See the
Index: books/handbook/disks/chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/disks/chapter.sgml,v
retrieving revision 1.92
diff -u -r1.92 chapter.sgml
--- books/handbook/disks/chapter.sgml 27 Jul 2002 09:21:57 -0000 1.92
+++ books/handbook/disks/chapter.sgml 27 Jul 2002 13:16:28 -0000
@@ -850,7 +850,7 @@
that is an image of a directory tree in the Unix filesystem name
space. The simplest usage is:</para>
- <screen>&prompt.root; <userinput>mkisofs <option>-o</option> <replaceable>imagefile.iso</replaceable> <replaceable>/path/to/tree</replaceable></userinput></screen>
+ <screen>&prompt.root; <userinput>mkisofs -o <replaceable>imagefile.iso</replaceable> <replaceable>/path/to/tree</replaceable></userinput></screen>
<indexterm>
<primary>filesystems</primary>
@@ -929,7 +929,7 @@
as <filename>/usr/sbin/burncd</filename>. Usage is very simple, as
it has few options:</para>
- <screen>&prompt.root; <userinput>burncd <option>-f</option> <replaceable>cddevice</replaceable> data <replaceable>imagefile.iso</replaceable> fixate</userinput></screen>
+ <screen>&prompt.root; <userinput>burncd -f <replaceable>cddevice</replaceable> data <replaceable>imagefile.iso</replaceable> fixate</userinput></screen>
<para>Will burn a copy of <replaceable>imagefile.iso</replaceable> on
<replaceable>cddevice</replaceable>. The default device is
@@ -957,7 +957,7 @@
is even simpler than <command>burncd</command>. Burning an ISO 9660
image is done with:</para>
- <screen>&prompt.root; <userinput>cdrecord <option>dev=</option><replaceable>device</replaceable> <replaceable>imagefile.iso</replaceable></userinput></screen>
+ <screen>&prompt.root; <userinput>cdrecord dev=<replaceable>device</replaceable> <replaceable>imagefile.iso</replaceable></userinput></screen>
<para>The tricky part of using <command>cdrecord</command> is finding
the <option>dev</option> to use. To find the proper setting, use
@@ -967,7 +967,7 @@
<primary>CDROMs</primary>
<secondary>burning</secondary>
</indexterm>
- <screen>&prompt.root; <userinput>cdrecord <option>-scanbus</option></userinput>
+ <screen>&prompt.root; <userinput>cdrecord -scanbus</userinput>
Cdrecord 1.9 (i386-unknown-freebsd4.2) Copyright (C) 1995-2000 Jörg Schilling
Using libscg version 'schily-0.1'
scsibus0:
@@ -994,7 +994,7 @@
numbers separated by commas as the value for
<option>dev</option>. In this case, the CRW device is 1,5,0, so the
appropriate input would be
- <userinput><option>dev</option>=1,5,0</userinput>. There are easier
+ <option>dev=1,5,0</option>. There are easier
ways to specify this value; see &man.cdrecord.1; for
details. That is also the place to look for information on writing
audio tracks, controlling the speed, and other things.</para>
Index: books/handbook/kernelconfig/chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
retrieving revision 1.78
diff -u -r1.78 chapter.sgml
--- books/handbook/kernelconfig/chapter.sgml 1 Jul 2002 18:38:17 -0000 1.78
+++ books/handbook/kernelconfig/chapter.sgml 27 Jul 2002 13:08:20 -0000
@@ -164,9 +164,9 @@
you have access to an <quote>official</quote> FreeBSD CDROM, then
you can also install the source from the command line:</para>
- <screen>&prompt.root; <userinput>mount</userinput> /cdrom
-&prompt.root; <userinput>mkdir -p</userinput> <filename>/usr/src/sys</filename>
-&prompt.root; <userinput>ln -s</userinput> /usr/src/sys /sys
+ <screen>&prompt.root; <userinput>mount /cdrom</userinput>
+&prompt.root; <userinput>mkdir -p /usr/src/sys</userinput>
+&prompt.root; <userinput>ln -s /usr/src/sys /sys</userinput>
&prompt.root; <userinput>cat /cdrom/sys/ssys.[a-d]* | tar -xzvf</userinput></screen>
</note>
Index: books/handbook/ppp-and-slip/chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.sgml,v
retrieving revision 1.83
diff -u -r1.83 chapter.sgml
--- books/handbook/ppp-and-slip/chapter.sgml 22 Jul 2002 15:57:39 -0000 1.83
+++ books/handbook/ppp-and-slip/chapter.sgml 27 Jul 2002 13:08:55 -0000
@@ -2255,7 +2255,7 @@
manuals pages for &man.chmod.1; and &man.chown.8; for further
information.</para>
<screen>&prompt.root; <userinput>chown root:wheel /etc/ppp/ppp.conf</userinput>
-&prompt.root; <userinput>chmod 600 <filename>/etc/ppp/ppp.conf</filename></userinput></screen>
+&prompt.root; <userinput>chmod 600 /etc/ppp/ppp.conf</userinput></screen>
</warning>
<para>This will open a tunnel for a PPP session to your DSL router.
Index: books/handbook/printing/chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/printing/chapter.sgml,v
retrieving revision 1.57
diff -u -r1.57 chapter.sgml
--- books/handbook/printing/chapter.sgml 29 Apr 2002 12:22:28 -0000 1.57
+++ books/handbook/printing/chapter.sgml 27 Jul 2002 13:09:57 -0000
@@ -629,7 +629,7 @@
<step>
<para>Type:</para>
- <screen>&prompt.root; <userinput>lptcontrol -i -d <filename>/dev/lpt<replaceable>N</replaceable></filename></userinput></screen>
+ <screen>&prompt.root; <userinput>lptcontrol -i -d /dev/lpt<replaceable>N</replaceable></userinput></screen>
<para>to set interrupt-driven mode for
<literal>lpt<replaceable>N</replaceable></literal>.</para>
@@ -638,7 +638,7 @@
<step>
<para>Type:</para>
- <screen>&prompt.root; <userinput>lptcontrol -p -d <filename>/dev/lpt<replaceable>N</replaceable></filename></userinput></screen>
+ <screen>&prompt.root; <userinput>lptcontrol -p -d /dev/lpt<replaceable>N</replaceable></userinput></screen>
<para>to set polled-mode for
<literal>lpt<replaceable>N</replaceable></literal>.</para>
Index: books/handbook/users/chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/users/chapter.sgml,v
retrieving revision 1.33
diff -u -r1.33 chapter.sgml
--- books/handbook/users/chapter.sgml 26 Jul 2002 19:51:56 -0000 1.33
+++ books/handbook/users/chapter.sgml 27 Jul 2002 13:19:24 -0000
@@ -1007,8 +1007,8 @@
<example>
<title>Adding a Group Using &man.pw.8;</title>
- <screen>&prompt.root; <userinput><command>pw</command> groupadd <groupname>teamtwo</groupname></userinput>
-&prompt.root; <userinput><command>pw</command> groupshow <groupname>teamtwo</groupname></userinput>
+ <screen>&prompt.root; <userinput>pw groupadd teamtwo</userinput>
+&prompt.root; <userinput>pw groupshow teamtwo</userinput>
teamtwo:*:1100:</screen>
</example>
@@ -1021,8 +1021,8 @@
<example>
<title>Adding Somebody to a Group Using &man.pw.8;</title>
- <screen>&prompt.root; <userinput><command>pw</command> groupmod <groupname>teamtwo</groupname> <option>-M</option> <username>jru</username></userinput>
-&prompt.root; <userinput><command>pw</command> groupshow <groupname>teamtwo</groupname></userinput>
+ <screen>&prompt.root; <userinput>pw groupmod teamtwo -M jru</userinput>
+&prompt.root; <userinput>pw groupshow teamtwo</userinput>
teamtwo:*:1100:jru</screen>
</example>
@@ -1040,7 +1040,7 @@
<example>
<title>Using &man.id.1; to Determine Group Membership</title>
- <screen>&prompt.user; <userinput><command>id</command> <username>jru</username></userinput>
+ <screen>&prompt.user; <userinput>id jru</userinput>
uid=1001(jru) gid=1001(jru) groups=1001(jru), 1100(teamtwo)</screen>
</example>
>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?200207271338.g6RDcPt5006632>