OpenBSD CVS

CVS log for src/usr.bin/mandoc/apropos.1


[BACK] Up to [local] / src / usr.bin / mandoc

Request diff between arbitrary revisions


Default branch: MAIN


Revision 1.45 / (download) - annotate - [select for diffs], Thu Oct 1 22:47:26 2020 UTC (3 years, 7 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_7_5_BASE, OPENBSD_7_5, OPENBSD_7_4_BASE, OPENBSD_7_4, OPENBSD_7_3_BASE, OPENBSD_7_3, OPENBSD_7_2_BASE, OPENBSD_7_2, OPENBSD_7_1_BASE, OPENBSD_7_1, OPENBSD_7_0_BASE, OPENBSD_7_0, OPENBSD_6_9_BASE, OPENBSD_6_9, HEAD
Changes since 1.44: +4 -3 lines
Diff to previous 1.44 (colored)

add a missing .Pp

Revision 1.44 / (download) - annotate - [select for diffs], Thu Oct 1 22:30:14 2020 UTC (3 years, 7 months ago) by ians
Branch: MAIN
Changes since 1.43: +4 -1 lines
Diff to previous 1.43 (colored)

add example to apropos.1 to list all manuals in a given section

ok schwarze@

Revision 1.43 / (download) - annotate - [select for diffs], Mon Jul 20 14:52:12 2020 UTC (3 years, 9 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_8_BASE, OPENBSD_6_8
Changes since 1.42: +3 -4 lines
Diff to previous 1.42 (colored)

as jmc@ points out, i missed a few instances of .Xr more 1

Revision 1.42 / (download) - annotate - [select for diffs], Mon Jul 20 14:25:22 2020 UTC (3 years, 9 months ago) by schwarze
Branch: MAIN
Changes since 1.41: +4 -4 lines
Diff to previous 1.41 (colored)

Switch the default pager from "more -s" to "less".

POSIX explicitly allows using a different default pager if that
is documented.  The pager provided in the OpenBSD base system is
less(1).  It can merely be called as more(1) for compatibility.
Our man(1) implementation uses less(1) features that traditional
more(1) did not provide, in particular tagging.  Besides, as noted
by deraadt@, the user interface of less(1) is slightly more refined
and preferable over the user inferface of more(1).
This switch was originally suggested by Ian Ropers.

As explained by jmc@ and deraadt@, the -s flag was added a very
long time ago when an antique version of groff(1) had an annoying
bug in terminal output that would randomly display blank lines in
the middle of pages.  Clearly, -s has no longer been needed for
many years, so drop it from the default pager invocation.

OK deraadt@ jmc@ martijn@ job@

Revision 1.41 / (download) - annotate - [select for diffs], Thu Nov 22 12:32:10 2018 UTC (5 years, 5 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_7_BASE, OPENBSD_6_7, OPENBSD_6_6_BASE, OPENBSD_6_6, OPENBSD_6_5_BASE, OPENBSD_6_5
Changes since 1.40: +4 -20 lines
Diff to previous 1.40 (colored)

Correct and shorten the description of the sort order of apropos(1)
results.  As a matter of fact, which manpath the page comes from
does not matter in that context.  That only matters for the priority
of pages in man(1) mode (without -a, -f, and -k).

Noticed while working on a patch from Yuri Pankov <yuripv at FreeBSD>.

Revision 1.40 / (download) - annotate - [select for diffs], Mon Nov 19 19:27:29 2018 UTC (5 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.39: +29 -12 lines
Diff to previous 1.39 (colored)

Improve POSIX compliance by making case-insensitive extended
regular expressions the default in man(1) -k searches, also matching
what the man-db package used by many Linux distributions does.

Originally requested by Wolfram Schneider <wosch at FreeBSD>
via Yuri Pankov <yuripv at FreeBSD>.

Feedback and OK cheloha@, and no objections when shown on tech@.

Thanks to cheloha@ for pointing out that POSIX requires this behaviour
and for the suggestion to explicitly say that *extended* regular
expressions are used here.

While here, unify spelling of case-[in]sensitive, fix a typo,
update the EXAMPLES, and add a STANDARDS section.

Revision 1.39 / (download) - annotate - [select for diffs], Fri Feb 23 18:53:49 2018 UTC (6 years, 2 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_4_BASE, OPENBSD_6_4, OPENBSD_6_3_BASE, OPENBSD_6_3
Changes since 1.38: +25 -2 lines
Diff to previous 1.38 (colored)

clarify documentation of macro keys

Revision 1.38 / (download) - annotate - [select for diffs], Tue Jul 4 23:38:49 2017 UTC (6 years, 10 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_2_BASE, OPENBSD_6_2
Changes since 1.37: +2 -2 lines
Diff to previous 1.37 (colored)

cross reference to self; found with mandoc(1)

Revision 1.37 / (download) - annotate - [select for diffs], Mon Mar 27 18:51:20 2017 UTC (7 years, 1 month ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_1_BASE, OPENBSD_6_1
Changes since 1.36: +3 -3 lines
Diff to previous 1.36 (colored)

simplify the SYNOPSIS as well, just like the option lists;
suggested by and OK jmc@

Revision 1.36 / (download) - annotate - [select for diffs], Mon Mar 27 14:39:56 2017 UTC (7 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.35: +5 -12 lines
Diff to previous 1.35 (colored)

Simplify: mention at one place that -fkl override each other,
rather than stating it separately for each option.
Suggested, OKed, and tweaked by jmc@.

Revision 1.35 / (download) - annotate - [select for diffs], Sat Mar 25 12:46:34 2017 UTC (7 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.34: +7 -29 lines
Diff to previous 1.34 (colored)

For some options that are rarely needed in apropos(1) and man(1),
delete the verbose descriptions and point to man(1) and mandoc(1),
respectively, instead.  That shortens the pages and makes them
easier to read.
Tweaks and OK jmc@, based in part on ideas from tedu@.

Revision 1.34 / (download) - annotate - [select for diffs], Sat Mar 18 19:50:58 2017 UTC (7 years, 2 months ago) by schwarze
Branch: MAIN
Changes since 1.33: +24 -19 lines
Diff to previous 1.33 (colored)

Correct description of MANPATH, and a few more improvements
to the ENVIRONMENT section; OK jmc@

Revision 1.33 / (download) - annotate - [select for diffs], Fri Mar 17 17:24:26 2017 UTC (7 years, 2 months ago) by schwarze
Branch: MAIN
Changes since 1.32: +25 -4 lines
Diff to previous 1.32 (colored)

Document man(1) section selection priority,
and correct description of apropos(1) output search order.
Suggested by tb@.

Revision 1.32 / (download) - annotate - [select for diffs], Tue Jan 31 19:43:23 2017 UTC (7 years, 3 months ago) by schwarze
Branch: MAIN
Changes since 1.31: +6 -2 lines
Diff to previous 1.31 (colored)

add missing HISTORY information

Revision 1.31 / (download) - annotate - [select for diffs], Fri Apr 3 08:45:27 2015 UTC (9 years, 1 month ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_0_BASE, OPENBSD_6_0, OPENBSD_5_9_BASE, OPENBSD_5_9, OPENBSD_5_8_BASE, OPENBSD_5_8
Changes since 1.30: +4 -3 lines
Diff to previous 1.30 (colored)

No need to hardcode /usr/bin/ as the path to more(1); helps portability.
We don't hardcode the paths to gunzip(1) and cmp(1) either.
Discussed with ajacoutot@.

Revision 1.30 / (download) - annotate - [select for diffs], Sun Mar 29 21:12:00 2015 UTC (9 years, 1 month ago) by bentley
Branch: MAIN
Changes since 1.29: +8 -8 lines
Diff to previous 1.29 (colored)

Escape punctuation characters that have a different meaning in -Tpdf.

~, `, and ' get translated to non-ASCII characters by most troff
implementations when generating PostScript/PDF output. When the original
ASCII character is meant, it needs to be manually escaped.

discussed with jmc@ schwarze@; ok schwarze@

Revision 1.29 / (download) - annotate - [select for diffs], Mon Feb 16 16:18:02 2015 UTC (9 years, 3 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_7_BASE, OPENBSD_5_7
Changes since 1.28: +3 -5 lines
Diff to previous 1.28 (colored)

Delete the -V option.  It serves no purpose but keeps confusing people.

Revision 1.28 / (download) - annotate - [select for diffs], Thu Oct 30 00:05:02 2014 UTC (9 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.27: +3 -3 lines
Diff to previous 1.27 (colored)

support UTF-8 and ISO-8859-1 input by integrating modified parts
of kristaps@' version of the preconv(1) utility into mandoc(1);
positive feedback from bentley@ and no concern raised when shown on tech@

Revision 1.27 / (download) - annotate - [select for diffs], Wed Sep 3 05:17:08 2014 UTC (9 years, 8 months ago) by schwarze
Branch: MAIN
Changes since 1.26: +8 -3 lines
Diff to previous 1.26 (colored)

Implement the traditional -h option for man(1): show the SYNOPSIS only.
As usual, we get mandoc -h and apropos -h for free.
Try stuff like "apropos -h In=dirent" or "apropos -h Fa=timespec".

Only useful for terminal output, so -Tps, -Tpdf, -Thtml ignore -h for now.

Revision 1.26 / (download) - annotate - [select for diffs], Sat Aug 30 18:04:52 2014 UTC (9 years, 8 months ago) by schwarze
Branch: MAIN
Changes since 1.25: +21 -5 lines
Diff to previous 1.25 (colored)

Introduce a man(1) -l option as an alias for mandoc -a.
Basically, this does the same as man -l in Linux man-db.
The point is that now all functionality of the combined tool
is reachable from the man(1) command name:
apropos = man -k, whatis = man -f, mandoc = man -cl.

Originally suggested by Carsten dot Kunze at arcor dot de,
current maintainer of the Heirloom Documentation Tools.

While here, add various missing information to the usage()
and to the manuals.

Revision 1.25 / (download) - annotate - [select for diffs], Wed Aug 27 00:06:08 2014 UTC (9 years, 8 months ago) by schwarze
Branch: MAIN
Changes since 1.24: +102 -14 lines
Diff to previous 1.24 (colored)

Add an implementation of man(1) into the /usr/bin/mandoc binary and
provide a unified set of command line options for mandoc(1), man(1),
apropos(1), and whatis(1), each option doing the same for all four.
Not adding any completely new options, only extending exiting ones
from one tool to the others.  New options are:
* apropos & whatis -acfkw  (in the past, these were man(1) only)
* apropos & whatis -a -IOTW  (in the past, mandoc(1) only)
* mandoc -ac  (in the past, man(1) only)
* man -IOTW  (in the past, mandoc(1) only)

Before we can decide whether or not we want to replace src/usr.bin/man
with this implementation, considerable bugfixing, testing, and
performance measurements are needed, which i'd rather do in the tree
than outside.  Note that these bugs only affect the new man(1) mode,
existing mandoc(1), apropos(1), and whatis(1) is fine.

The new functionality in mandoc(1), apropos(1), and whatis(1)
is fully enabled.  To play with the new man(1), you can try:
# mv /usr/bin/man /usr/bin/oman
# ln -s /usr/bin/mandoc /usr/bin/man

Positive feedback about the general direction from sthen@ and jmc@,
and deraadt@ is not against it.

Revision 1.24 / (download) - annotate - [select for diffs], Thu Apr 24 00:28:02 2014 UTC (10 years ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_6_BASE, OPENBSD_5_6
Changes since 1.23: +4 -4 lines
Diff to previous 1.23 (colored)

misplaced punctuation

Revision 1.23 / (download) - annotate - [select for diffs], Fri Apr 18 09:46:41 2014 UTC (10 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.22: +32 -25 lines
Diff to previous 1.22 (colored)

Fix a few lies; polish wording and formatting while here.

Revision 1.22 / (download) - annotate - [select for diffs], Tue Apr 15 23:01:34 2014 UTC (10 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.21: +2 -3 lines
Diff to previous 1.21 (colored)

remove documentation of the former macro key "NAME";
it got deleted with mansearch.h rev. 1.8

Revision 1.21 / (download) - annotate - [select for diffs], Fri Apr 4 15:55:17 2014 UTC (10 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.20: +4 -2 lines
Diff to previous 1.20 (colored)

Remember which names are in the NAME section.
This helps to find missing MLINKS.
Database build times do not change and database growth is minimal
(1.2% with -Q, 0.7% without -Q in /usr/share/man),
so making this optional would be pointless.

Revision 1.20 / (download) - annotate - [select for diffs], Mon Mar 17 11:29:11 2014 UTC (10 years, 2 months ago) by schwarze
Branch: MAIN
Changes since 1.19: +22 -4 lines
Diff to previous 1.19 (colored)

describe new features

Revision 1.19 / (download) - annotate - [select for diffs], Mon Mar 17 09:25:39 2014 UTC (10 years, 2 months ago) by schwarze
Branch: MAIN
Changes since 1.18: +3 -7 lines
Diff to previous 1.18 (colored)

remove Berkeley DB parts

Revision 1.18 / (download) - annotate - [select for diffs], Sat Jul 13 19:27:46 2013 UTC (10 years, 10 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_5_BASE, OPENBSD_5_5, OPENBSD_5_4_BASE, OPENBSD_5_4
Changes since 1.17: +3 -4 lines
Diff to previous 1.17 (colored)

For citing the names and email addresses of authors,
consistently use the style ".An name Aq Mt email".

Triggered by a question from Jan Stary <hans at stare dot cz>,
ok jmc@.

Revision 1.17 / (download) - annotate - [select for diffs], Sat Jan 14 23:31:33 2012 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_3_BASE, OPENBSD_5_3, OPENBSD_5_2_BASE, OPENBSD_5_2, OPENBSD_5_1_BASE, OPENBSD_5_1
Changes since 1.16: +34 -4 lines
Diff to previous 1.16 (colored)

add/fix HISTORY and AUTHORS

Revision 1.16 / (download) - annotate - [select for diffs], Tue Jan 10 09:45:13 2012 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.15: +10 -10 lines
Diff to previous 1.15 (colored)

Continue using the traditional name makewhatis(8),
do not rename to mandocdb(8):  Even though there is some
additional functionality, the basic purpose remains the same.
Requested by espie@; "decide fast" deraadt@.

Revision 1.15 / (download) - annotate - [select for diffs], Mon Jan 9 01:59:08 2012 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.14: +4 -4 lines
Diff to previous 1.14 (colored)

Rename whatis.{db,index} back to mandoc.{db,index}
such that makewhatis(8) called from pkg_delete(1)
does not fail trying to open old-style whatis.db files as btree(3).
Suggested by espie@ deraadt@ millert@

Revision 1.14 / (download) - annotate - [select for diffs], Thu Jan 5 22:15:17 2012 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.13: +24 -16 lines
Diff to previous 1.13 (colored)

improve EXAMPLES; feedback and ok jmc@

Revision 1.13 / (download) - annotate - [select for diffs], Mon Dec 26 12:45:58 2011 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.12: +27 -21 lines
Diff to previous 1.12 (colored)

Document whatis(1) -S and -s; leading, trailing, and double colons
in the MANPATH; and the new whatis.index file.
Include some synching to apropos(1) and to the usage() string.
Use some feedback from jmc@.

Revision 1.12 / (download) - annotate - [select for diffs], Sun Dec 25 20:15:54 2011 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.11: +16 -14 lines
Diff to previous 1.11 (colored)

State default usage before listing arguments of a utility;
from kristaps@, ok jmc@.

Revision 1.11 / (download) - annotate - [select for diffs], Sun Dec 25 16:52:55 2011 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.10: +4 -4 lines
Diff to previous 1.10 (colored)

Use the traditional name "whatis.db" for the mandocdb(8) databases.
Requested by deraadt@, ok kristaps@.

CAUTION:
If you run "sudo mandocdb" after this, the old apropos(1) and whatis(1)
will not work any longer.  To get temporary copies of the new ones, run:
cd /usr/bin; rm -f apropos whatis; ln -s mandoc apropos; ln -s mandoc whatis

Revision 1.10 / (download) - annotate - [select for diffs], Sat Dec 24 21:51:40 2011 UTC (12 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.9: +14 -3 lines
Diff to previous 1.9 (colored)

Support leading, trailing and double colons in MANPATH
to prepend, append or insert the man.conf(5) default path;
compatible with GNU manpath(1), implementation by kristaps@,
heavily tweaked by me.

Revision 1.9 / (download) - annotate - [select for diffs], Mon Dec 12 01:59:13 2011 UTC (12 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.8: +24 -2 lines
Diff to previous 1.8 (colored)

implement -C (alternative config file) for apropos(1) and mandocdb(8);
ok kristaps@

Revision 1.8 / (download) - annotate - [select for diffs], Tue Nov 29 22:30:56 2011 UTC (12 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.7: +18 -24 lines
Diff to previous 1.7 (colored)

Sync to bsd.lv, mostly from kristaps@.
Make `-i' only apply to regular expressions.
For substring matches, always use strcasestr().
Also, improve some manuals and comments.

Revision 1.7 / (download) - annotate - [select for diffs], Tue Nov 29 01:07:30 2011 UTC (12 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.6: +83 -5 lines
Diff to previous 1.6 (colored)

tables of matchable keys; from kristaps@

Revision 1.6 / (download) - annotate - [select for diffs], Sat Nov 26 16:41:35 2011 UTC (12 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.5: +32 -21 lines
Diff to previous 1.5 (colored)

Resync to bsd.lv, most code from kristaps@.
In particular, support the MANPATH environment variable
and don't confuse index record numbers when working with
multiple mandoc databases at once.
Besides, remove lots of gratuitious code and whitespace differences.

Revision 1.5 / (download) - annotate - [select for diffs], Sat Nov 26 13:07:15 2011 UTC (12 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.4: +3 -4 lines
Diff to previous 1.4 (colored)

minor sync to bsd.lv

Revision 1.4 / (download) - annotate - [select for diffs], Fri Nov 18 01:10:03 2011 UTC (12 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.3: +96 -52 lines
Diff to previous 1.3 (colored)

Support parenthised subexpressions in apropos(1);
written by kristaps@, massive conflict resolution by me.
Lightly tested, putting it in for polishing it in-tree.
This concludes p2k11 for me, thanks robert@!

Revision 1.3 / (download) - annotate - [select for diffs], Sun Nov 13 09:58:21 2011 UTC (12 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.2: +21 -40 lines
Diff to previous 1.2 (colored)

Split the common code to be reused by other mandocdb clients,
for example the future man.cgi, out of apropos.c (which still
contains the apropos(1) main program, command line handling, and
the terminal output formatter) into apropos_db.{h,c} (which now
contains the database searching backend code).

While here,
* Drop the -e option; to search for exact strings, use REs.
* Drop the -r option (more changes related to this coming soon).
* Use the traditional -s and -S instead of inventing our own options.
* Drop the sort option (at least for now), it got in the way.

Written by kristaps@.

Revision 1.2 / (download) - annotate - [select for diffs], Sun Oct 9 17:59:56 2011 UTC (12 years, 7 months ago) by schwarze
Branch: MAIN
Changes since 1.1: +4 -3 lines
Diff to previous 1.1 (colored)

Sync to version 1.12.0; all code by kristaps@:
Implement .Rv in -Tman.
Let -man -Tman work a bit like cat(1).
Add the -Ofragment option to -T[x]html.
Minor fixes in -T[x]html.
Lots of apropos(1) and -Tman code cleanup.

Revision 1.1 / (download) - annotate - [select for diffs], Thu Oct 6 23:04:16 2011 UTC (12 years, 7 months ago) by schwarze
Branch: MAIN

1) Import the future apropos(1) replacement written by kristaps@.
2) Link both that one and mandocdb(8) into the mandoc(1) binary.
3) Install a /usr/bin/mandocdb hardlink and the mandocdb(8) manual.

Do not replace /usr/bin/apropos by a hardlink yet because it is
not ready for production, and ports integration is still missing.
Development will be done in the tree, even the user interfaces
are still subject to change at this point.

Both jmc@ and deraadt@ agree with getting this in.

This form allows you to request diff's between any two revisions of a file. You may select a symbolic revision name using the selection box or you may type in a numeric name using the type-in text box.