Date: Tue, 18 Sep 2001 17:23:11 +0300 (EEST) From: Giorgos Keramidas <charon@labs.gr> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/30657: markup sh, csh and tcsh in <command> tags, add <filename> and <keycap>, in new-users article Message-ID: <200109181423.f8IENBu04081@hades.hell.gr>
next in thread | raw e-mail | index | archive | help
>Number: 30657
>Category: docs
>Synopsis: markup sh, csh and tcsh in <command> tags, add <filename> and <keycap>, in new-users article
>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: Tue Sep 18 15:30:01 PDT 2001
>Closed-Date:
>Last-Modified:
>Originator: Giorgos Keramidas
>Release: FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hades.hell.gr 5.0-CURRENT FreeBSD 5.0-CURRENT #5: Tue Sep 4
19:49:44 EEST 2001 root@hades.hell.gr:/usr/obj/usr/src/sys/CHARON i386
>Description:
While finishing the translation of the new-users article, I noticed that
sh, csh and tcsh are written in running text without being tagged as
commands. Surround these with <command>..</command>.
Also change `escape' to <keycap>Esc</keycap>, and
add <filename> to a literal /usr/local/bin/tcsh instance.
>How-To-Repeat:
>Fix:
--- patch begins here ---
Index: article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/new-users/article.sgml,v
retrieving revision 1.25
diff -u -r1.25 article.sgml
--- article.sgml 17 Sep 2001 01:29:35 -0000 1.25
+++ article.sgml 18 Sep 2001 14:10:51 -0000
@@ -93,8 +93,8 @@
</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
+ defaults to save. You might want to make the default shell <command>csh</command>
+ instead of <command>sh</command>, if it suggests <command>sh</command> as the default. Otherwise just
press enter to accept each default. These defaults are saved in
<filename>/etc/adduser.conf</filename>, an editable file.</para>
@@ -259,7 +259,7 @@
convenient). You can create other aliases by editing
<filename>.cshrc</filename>. You can make these aliases
available to all users on the system by putting them in the
- system-wide csh configuration file,
+ system-wide <command>csh</command> configuration file,
<filename>/etc/csh.cshrc</filename>.</para>
</sect1>
@@ -877,7 +877,7 @@
are kept, <command>rehash</command>, and then put the following lines
in <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>
+ system-wide <command>csh</command> start-up file:</para>
<informalexample>
<programlisting>setenv XKEYSYMDB /usr/X11R6/lib/X11/XKeysymDB
@@ -909,17 +909,17 @@
files: a series of commands to be run without your
intervention.</para>
- <para>Two shells come installed with FreeBSD: csh and sh. csh is
+ <para>Two shells come installed with FreeBSD: <command>csh</command> and <command>sh</command>. <command>csh</command> is
good for command-line work, but scripts should be written with
- sh (or bash). You can find out what shell you have by typing
+ <command>sh</command> (or <command>bash</command>). You can find out what shell you have by typing
<command>echo $SHELL</command>.</para>
- <para>The csh shell is okay, but tcsh does everything csh does and
+ <para>The <command>csh</command> shell is okay, but <command>tcsh</command> does everything <command>csh</command> does and
more. It allows you to recall commands with the arrow keys
- and edit them. It has tab-key completion of filenames (csh uses
- the escape key), and it lets you switch to the directory you
+ and edit them. It has tab-key completion of filenames (<command>csh</command> uses
+ the <keycap>Esc</keycap> key), and it lets you switch to the directory you
were last in with <command>cd -</command>. It's also much
- easier to alter your prompt with tcsh. It makes life a lot
+ easier to alter your prompt with <command>tcsh</command>. It makes life a lot
easier.</para>
<para>Here are the three steps for installing a new shell:</para>
@@ -929,20 +929,20 @@
<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
+ (assuming you're installing <command>tcsh</command>) to make sure it got
installed.</para>
</step>
<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
+ <filename>/usr/local/bin/tcsh</filename>, and save the file. (Some ports may do
this for you.)</para>
</step>
<step>
<para>Use the <command>chsh</command> command to change your
- shell to tcsh permanently, or type <command>tcsh</command>
+ shell to <command>tcsh</command> permanently, or type <command>tcsh</command>
at the prompt to change your shell without logging in
again.</para>
</step>
@@ -950,27 +950,27 @@
<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 than <command>sh</command> or <command>csh</command> 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
+ you the <command>tcsh</command> 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.</programlisting></para>
</note>
- <para>When tcsh starts up, it will read the
+ <para>When <command>tcsh</command> starts up, it will read the
<filename>/etc/csh.cshrc</filename> and
- <filename>/etc/csh.login</filename> files, as does csh. It will
+ <filename>/etc/csh.login</filename> files, as does <command>csh</command>. It will
also read the <filename>.login</filename> file in your home
directory and the <filename>.cshrc</filename> file as well,
unless you provide a <filename>.tcshrc</filename> file. This
you can do by simply copying <filename>.cshrc</filename> to
<filename>.tcshrc</filename>.</para>
- <para>Now that you've installed tcsh, you can adjust your prompt.
- You can find the details in the manual page for tcsh, but here
+ <para>Now that you've installed <command>tcsh</command>, you can adjust your prompt.
+ You can find the details in the manual page for <command>tcsh</command>, but here
is a line to put in your <filename>.tcshrc</filename> that will
tell you how many commands you have typed, what time it is, and
what directory you are in. It also produces a
--- patch ends here ---
>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?200109181423.f8IENBu04081>