* mandoc: In the opening paragraph, mention search expressions and jumping
@ 2025-01-26 14:43 schwarze
0 siblings, 0 replies; only message in thread
From: schwarze @ 2025-01-26 14:43 UTC (permalink / raw)
To: source
Log Message:
-----------
In the opening paragraph, mention search expressions and jumping to terms
because those are the two most important features that set our man(1)
apart from older implementations. Also, add one example for each of them
to the EXAMPLES section.
Joint work with jmc@ and <onf at disroot dot org>, and OK jmc@.
Started by a suggestion from onf to improve the DESCRIPTION,
and then jmc@ proposed to also add more EXAMPLES.
Modified Files:
--------------
mandoc:
man.1
Revision Data
-------------
Index: man.1
===================================================================
RCS file: /home/cvs/mandoc/mandoc/man.1,v
diff -Lman.1 -Lman.1 -u -p -r1.41 -r1.42
--- man.1
+++ man.1
@@ -1,4 +1,4 @@
-.\" $Id$
+.\" $Id$
.\"
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -58,7 +58,19 @@ a specific category
.Pq Ar section
or
machine architecture
-.Pq Ar subsection .
+.Pq Ar subsection ,
+or searched for with
+.Fl k
+using
+.Xr apropos 1
+search expressions.
+The default pager,
+.Xr less 1 ,
+supports the command
+.Ic :t
+to jump to definitions of specific terms (see
+.Dv MANPAGER ,
+below).
.Pp
The options are as follows:
.Bl -tag -width Ds
@@ -345,6 +357,26 @@ See
.Xr mandoc 1
for details.
.Sh EXAMPLES
+Show all manual pages that mention the
+.Ev PWD
+environment variable:
+.Pp
+.Dl $ man -ak Ev=PWD
+.Pp
+Show the
+.Xr ksh 1
+manual and jump to the place where the
+.Ic pwd
+builtin command is described:
+.Pp
+.Dl $ man -O tag=pwd ksh
+.Pp
+Equivalently, use the command
+.Ql man ksh ,
+then type
+.Ql :tpwd
+and press the return key.
+.Pp
Format a page for pasting extracts into an email message \(em
avoid printing any UTF-8 characters, reduce the width to ease
quoting in replies, and remove markup:
--
To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2025-01-26 14:43 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-01-26 14:43 mandoc: In the opening paragraph, mention search expressions and jumping schwarze
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).