Skip site navigation (1)Skip section navigation (2)
Date:      9 Oct 1999 13:05:01 -0000
From:      nbm@rucus.ru.ac.za
To:        FreeBSD-gnats-submit@freebsd.org
Subject:   docs/14236: markup fixes for new-users article
Message-ID:  <19991009130501.75613.qmail@mithrandr.moria.org>

next in thread | raw e-mail | index | archive | help

>Number:         14236
>Category:       docs
>Synopsis:       markup fixes for new-users article
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sat Oct  9 09:40:01 PDT 1999
>Closed-Date:
>Last-Modified:
>Originator:     Neil Blakey-Milner
>Release:        FreeBSD 4.0-CURRENT i386
>Organization:
Rhodes University Computer Users' Society
>Environment:

FreeBSD mithrandr.moria.org 4.0-CURRENT FreeBSD 4.0-CURRENT #2: Wed Sep 29 17:30:21 SAST 1999     root@mithrandr.moria.org:/usr/src/sys/compile/MITHRANDR  i386

>Description:

# and % to &prompt entities.

Un-<para>-wrap examples.

Insert <procedure> and <step>s for a section.

>How-To-Repeat:

>Fix:

cvs diff: Diffing .
Index: article.sgml
===================================================================
RCS file: /home/nbm/ncvs/doc/en_US.ISO_8859-1/articles/new-users/article.sgml,v
retrieving revision 1.8
diff -u -r1.8 article.sgml
--- article.sgml	1999/10/04 21:36:22	1.8
+++ article.sgml	1999/10/09 11:21:45
@@ -42,27 +42,33 @@
 # indicating root. </para>
 
 <para>To log out (and get a new <systemitem class=prompt>login:</systemitem> prompt) type
+</para>
 <informalexample>
-<screen># <userinput>exit</userinput></screen>
+<screen>&prompt.root; <userinput>exit</userinput></screen>
 </informalexample>
+<para>
 as often as necessary.  Yes, press <keysym>enter</keysym> after
 commands, and remember that Unix is
 case-sensitive&mdash;<command>exit</command>, not
 <command>EXIT</command>.</para>
 
 <para>To shut down the machine type:
+</para>
 <informalexample>
-<screen># <userinput>/sbin/shutdown -h now</userinput></screen>
+<screen>&prompt.root; <userinput>/sbin/shutdown -h now</userinput></screen>
 </informalexample>
+<para>
 Or to reboot type
+</para>
 <informalexample>
-<screen># <userinput>/sbin/shutdown -r now</userinput></screen>
+<screen>&prompt.root; <userinput>/sbin/shutdown -r now</userinput></screen>
 </informalexample>
+<para>
 or
+</para>
 <informalexample>
-<screen># <userinput>/sbin/reboot</userinput></screen>
+<screen>&prompt.root; <userinput>/sbin/reboot</userinput></screen>
 </informalexample>
-</para>
 
 <para>You can also reboot with
 <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Delete</keycap></keycombo>. 
@@ -78,9 +84,11 @@
 
 <para>If you didn't create any users when you installed the system and
 are thus logged in as root, you should probably create a user now with
+</para>
 <informalexample>
 <screen># <userinput>adduser</userinput></screen>
 </informalexample>
+<para>
 The first time you use adduser, it might ask for some defaults to save.  You
 might want to make the default shell csh instead of sh, if it suggests
 sh as the default.  Otherwise just press enter to accept each default.
@@ -92,9 +100,11 @@
 if security (even kids around who might pound on the keyboard) is an
 issue.  When it asks you if you want to invite jack into other
 groups, type <userinput>wheel</userinput>
+</para>
 <informalexample>
 <screen>Login group is ``jack''. Invite jack into other groups: <userinput>wheel</userinput></screen>
 </informalexample>
+<para>
 This will make it possible to log in as <emphasis>jack</emphasis> and
 use the <command>su</command> command to become root.  Then you won't
 get scolded any more for logging in as root.</para>
@@ -132,6 +142,7 @@
 FreeBSD.</para>
 
 <para>Here are some commands and what they do:
+</para>
 <variablelist>
 <varlistentry><term><command>id</command></term>
 <listitem>
@@ -231,7 +242,7 @@
 </listitem>
 </varlistentry>
 </variablelist>
-
+<para>
 You'll notice aliases in <filename>.cshrc</filename> for some of the
 <command>ls</command> commands (they're very convenient). 
 You can create other aliases by editing <filename>.cshrc</filename>.
@@ -328,14 +339,15 @@
 want to run the commands for daily, weekly, and monthly maintenance
 now and then.  Run them as root and give each one time to finish
 before you start the next one, for now.
+</para>
 <informalexample>
-<screen># <userinput>/etc/daily</userinput>
+<screen>&prompt.root; <userinput>/etc/daily</userinput>
 <lineannotation>output omitted</lineannotation>
-# <userinput>/etc/weekly</userinput>
+&prompt.root; <userinput>/etc/weekly</userinput>
 <lineannotation>output omitted</lineannotation>
-# <userinput>/etc/monthly</userinput>
+&prompt.root; <userinput>/etc/monthly</userinput>
 <lineannotation>output omitted</lineannotation></screen>
-</informalexample></para>
+</informalexample>
 
 <para>If you get tired waiting, press
 <keycombo><keycap>Alt</keycap><keycap>F2</keycap></keycombo> to get
@@ -374,7 +386,7 @@
 excellent tutorial on vi in 
 <filename>/usr/src/contrib/nvi/docs/tutorial</filename> if you have 
 that installed; otherwise you can get it by ftp to
-ftp.cdrom.com in the directory 
+<hostid>ftp.cdrom.com</hostid> in the directory 
 FreeBSD/FreeBSD-current/src/contrib/nvi/docs/tutorial.</para>
 
 <para>Before you edit a 
@@ -382,37 +394,44 @@
 <filename>/etc/rc.conf</filename>.  You could just use <command>cd
 /etc</command> to get to the <filename>/etc</filename> directory and
 do:
+</para>
 <informalexample>
-<screen># <userinput>cp rc.conf rc.conf.orig</userinput></screen>
+<screen>&prompt.root; <userinput>cp rc.conf rc.conf.orig</userinput></screen>
 </informalexample>
-
+<para>
 This would copy <filename>rc.conf</filename> to
 <filename>rc.conf.orig</filename>, and you could later copy
 <filename>rc.conf.orig</filename> to <emphasis
 remap=tt>rc.conf</emphasis> to recover the original.  But even
 better would be moving (renaming) and then copying back:
+</para>
 <informalexample>
-<screen># <userinput>mv rc.conf rc.conf.orig</userinput>
-# <userinput>cp rc.conf.orig rc.conf</userinput></screen>
+<screen>&prompt.root; <userinput>mv rc.conf rc.conf.orig</userinput>
+&prompt.root; <userinput>cp rc.conf.orig rc.conf</userinput></screen>
 </informalexample>
-
+<para>
 because the <command>mv</command> command preserves the original date
 and owner of the file.  You can now edit
 <filename>rc.conf</filename>.  If you want the original back, you'd
 then <userinput>mv rc.conf rc.conf.myedit</userinput>
 (assuming you want to preserve your edited version) and then
+</para>
 <informalexample>
 <screen># <userinput>mv rc.conf.orig rc.conf</userinput></screen>
 </informalexample>
+<para>
 to put things back the way they were.</para>
   
 <para>To edit a file, type
+</para>
 <informalexample>
-<screen># <userinput>vi <replaceable>filename</replaceable></userinput></screen>
+<screen>&prompt.root; <userinput>vi <replaceable>filename</replaceable></userinput></screen>
 </informalexample>
+<para>
 Move through the text with the arrow keys.  <keycap>Esc</keycap> (the
 escape key) puts <command>vi</command> in command mode.  Here are some
 commands:
+</para>
 <variablelist>
 <varlistentry><term><command>x</command></term>
 <listitem>
@@ -445,8 +464,10 @@
 </listitem>
 </varlistentry>
 </variablelist>
+<para>
 Once you type <command>i</command> or <command>a</command>, you can enter text.
 <command>Esc</command> puts you back in command mode where you can type
+</para>
 <variablelist>
 <varlistentry><term><command>:w</command></term>
 <listitem>
@@ -516,7 +537,6 @@
 </listitem>
 </varlistentry>
 </variablelist>
-</para>
   
 <para>Practice with <command>vi</> in your home directory by creating
 a new file with <command>vi <replaceable>filename</></> and adding
@@ -549,35 +569,43 @@
 print it from DOS.  Suppose you want to read carefully about changing
 permissions on files (pretty important).  You can use the command
 man chmod to read about it.  The command
+</para>
 <informalexample>
-<screen># <userinput>man chmod | col -b &gt; chmod.txt</></screen>
+<screen>&prompt.user; <userinput>man chmod | col -b &gt; chmod.txt</></screen>
 </informalexample>
+<para>
 will remove formatting codes and send the man page to 
 the <filename>chmod.txt</filename> file
 instead of showing it on your screen.  Now put a dos-formatted
 diskette in your floppy drive a, <command>su</> to
 root, and type
+</para>
 <informalexample>
-<screen># <userinput>/sbin/mount -t msdos /dev/fd0 /mnt</></screen>
+<screen>&prompt.root; <userinput>/sbin/mount -t msdos /dev/fd0 /mnt</></screen>
 </informalexample>
+<para>
 to mount the floppy drive on <filename>/mnt</filename>.</para>
   
 <para>Now (you no longer need to be root, and you can type
 <command>exit</> to get back to being user jack) you can go to the
 directory where you created chmod.txt and copy the file to the floppy
 with:
+</para>
 <informalexample>
-<screen>% <userinput>cp chmod.txt /mnt</></screen>
+<screen>&prompt.user; <userinput>cp chmod.txt /mnt</></screen>
 </informalexample>
+<para>
 and use <command>ls /mnt</command> to get a directory listing of
 <filename>/mnt</filename>, which should show the file
 <filename>chmod.txt</filename>.</para>
 
 <para>You might especially want to make a file from
 <filename>/sbin/dmesg</filename> by typing
+</para>
 <informalexample>
-<screen>% <userinput>/sbin/dmesg &gt; dmesg.txt</></screen>
+<screen>&prompt.user; <userinput>/sbin/dmesg &gt; dmesg.txt</></screen>
 </informalexample>
+<para>
 and copying <filename>dmesg.txt</filename> to the floppy. 
 <command>/sbin/dmesg</command> is the boot log record, and it's
 useful to understand it because it shows what FreeBSD found when it
@@ -589,9 +617,11 @@
 
 <para>You can now dismount the floppy drive (as root) to get the disk
 out with
+</para>
 <informalexample>
-<screen># <userinput>/sbin/umount /mnt</></screen>
+<screen>&prompt.root; <userinput>/sbin/umount /mnt</></screen>
 </informalexample>
+<para>
 and reboot to go to DOS.  Copy these files to a DOS directory, call
 them up with DOS EDIT, Windows Notepad or Wordpad, or a word processor, make a
 minor change so the file has to be saved, and print as you normally
@@ -622,7 +652,6 @@
 <sect1>
 <title>Other Useful Commands</title>
 
-<para>
 <variablelist>
 <varlistentry><term><command>df</></term>
 <listitem>
@@ -685,13 +714,15 @@
   
 </listitem>
 </varlistentry>
-</variablelist></para>
+</variablelist>
 
 <para>Use <command>find</> to locate filename in <filename>/usr</filename>
 or any of its subdirectories with
+</para>
 <informalexample>
-<screen>% <userinput>find /usr -name "<replaceable>filename</>"</></screen>
+<screen>&prompt.user; <userinput>find /usr -name "<replaceable>filename</>"</></screen>
 </informalexample>
+<para>
 You can use <literal>*</literal> as a wildcard in
 <parameter>"<replaceable>filename</>"</> (which should be in
 quotes).  If you tell find to search in <filename>/</filename>
@@ -736,11 +767,11 @@
 <para>Find the port you want, say <command>kermit</>.  There will be
 a directory for it on the cdrom.  Copy the subdirectory to
 <filename>/usr/local</filename> (a good place for software you add
-that should be available to all users) with:
+that should be available to all users) with:</para>
 <informalexample>
-<screen># <userinput>cp -R /cdrom/ports/comm/kermit /usr/local</></screen>
+<screen>&prompt.root; <userinput>cp -R /cdrom/ports/comm/kermit /usr/local</></screen>
 </informalexample>
-
+<para>
 This should result in a <filename>/usr/local/kermit</filename>
 subdirectory that has all the files that the
 <command>kermit</command> subdirectory on the CDROM has.</para>
@@ -757,10 +788,10 @@
 <para>Then <command>cd</> to the subdirectory of
 <filename>/usr/local/kermit</filename> that has the file
 <filename>Makefile</>.  Type
+</para>
 <informalexample>
-<screen># <userinput>make all install</></screen>
+<screen>&prompt.root; <userinput>make all install</></screen>
 </informalexample>
-</para>
   
 <para>During this process the port will ftp to get any compressed
 files it needs that it didn't find on the cdrom or in
@@ -808,10 +839,12 @@
 <filename>.cshrc</filename> in each user's home directory or (easier)
 in <filename>/etc/csh.cshrc</filename>,  the system-wide csh start-up
 file:
+</para>
 <informalexample>
 <programlisting>setenv XKEYSYMDB /usr/X11R6/lib/X11/XKeysymDB
 setenv XNLSPATH /usr/X11R6/lib/X11/nls</>
 </informalexample>
+<para>
 This assumes that the file <filename>XKeysymDB</> and the directory
 <filename>nls</> are in <filename>/usr/X11R6/lib/X11</filename>; if
 they're not, find them and put them there.</para>
@@ -849,26 +882,30 @@
 
 <para>Here are the three steps for installing a new shell:</para>
 
-<para>	1. Install the shell as a port or a package, just as you 
+<procedure>
+<step><para>Install the shell as a port or a package, just as you 
 would any other port or package.  Use <command>rehash</command> and
 <command>which tcsh</command> (assuming you're installing tcsh) to
-make sure it got installed.</para>
+make sure it got installed.</para></step>
 
-<para>	2. As root, edit <filename>/etc/shells</filename>, adding
+<step><para>As root, edit <filename>/etc/shells</filename>, adding
 a line in the file for the new shell, in this case /usr/local/bin/tcsh,
-and save the file. (Some ports may do this for you.)</para>
+and save the file. (Some ports may do this for you.)</para></step>
 
-<para>	3. Use the <command>chsh</command> command to change your shell to
+<step><para>Use the <command>chsh</command> command to change your shell to
 tcsh permanently, or type <command>tcsh</command> at the prompt to
-change your shell without logging in again.</para>
+change your shell without logging in again.</para></step>
+</procedure>
 
-<para><emphasis>Note:  It can be dangerous to change root's shell</emphasis>  
+<note>
+<para>It can be dangerous to change root's shell
 to something other than sh or csh on early versions of FreeBSD and many
 other versions of Unix; you may not have a working shell when the system 
 puts you into single user mode.  The solution is to use <command>su -m</command>
 to become root, which will give you the tcsh as root, because the shell is part
 of the environment.  You can make this permanent by adding it to your
 <filename>.tcshrc</filename> file as an alias with <programlisting>alias su su -m.</></para>
+</note>
 
 <para>When tcsh starts up, it will read the 
 <filename>/etc/csh.cshrc</filename> and <filename>/etc/csh.login</filename>



>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?19991009130501.75613.qmail>