Date: Mon, 5 May 2008 20:18:16 +0200 From: "Gabor PALI" <pgj@FreeBSD.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/123425: [patch] Fix Wrong <keycap> Tag in Handbook Section 24.5.2 Message-ID: <481f4f6a.1c365e0a.1720.ffffab0e@mx.google.com> Resent-Message-ID: <200805051820.m45IK3x0007552@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 123425
>Category: docs
>Synopsis: [patch] Fix Wrong <keycap> Tag in Handbook Section 24.5.2
>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: Mon May 05 18:20:03 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator: Gabor PALI
>Release: FreeBSD 6.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD disznohal 6.3-STABLE FreeBSD 6.3-STABLE #4: Fri Apr 4 23:29:43 CEST 2008 dezzy@disznohal:/usr/obj/usr/src/sys/GENERIC_ i386
>Description:
I found a misused <keycap> tag in the FreeBSD Handbook, Chapter
24 (``Serial Communications''), Section 24.5.2 (``How Am I Expected
to Enter These AT Commands?''). I never used tip(1) but the man
page of it tells me those escape signals (prefixed by a tilde
character) are not simply keys but keystrokes or commands.
Therefore I think it should be marked up as a <command> (as in
the other parts of the chapter).
>How-To-Repeat:
>Fix:
--- serialcomms.patch.3.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml,v
retrieving revision 1.120
diff -u -r1.120 chapter.sgml
--- chapter.sgml 28 Dec 2007 11:11:43 -0000 1.120
+++ chapter.sgml 5 May 2008 04:37:34 -0000
@@ -1865,7 +1865,7 @@
(e.g.<filename>/dev/cuad0</filename>) and
<replaceable>speed</replaceable> is the speed
(e.g.<literal>57600</literal>). When you are done entering the AT
- commands hit <keycap>~.</keycap> to exit.</para>
+ commands type <command>~.</command> to exit.</para>
</sect2>
<sect2>
--- serialcomms.patch.3.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?481f4f6a.1c365e0a.1720.ffffab0e>