summaryrefslogtreecommitdiffstats
path: root/apropos.1
Commit message (Collapse)AuthorAgeFilesLines
* add example to apropos.1 to list all manuals in a given section;Ingo Schwarze2020-10-011-1/+5
| | | | patch from ians@
* Switch the default pager from "more -s" to "less".Ingo Schwarze2020-07-201-4/+3
| | | | | | | | | | | | | | | | | | | | | | POSIX explicitly allows using a different default pager if that is documented. Nowadays, the pager provided in most operating systems is less(1). 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. In ./configure, test whether less(1) is available. If not, fall back to more(1). In ./configure.local, support overriding the automatic test by setting BINM_PAGER. 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@ on the OpenBSD version of this patch.
* Correct and shorten the description of the sort order of apropos(1)Ingo Schwarze2018-11-221-18/+2
| | | | | | | | 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>.
* Improve POSIX compliance by making case-insensitive extendedIngo Schwarze2018-11-191-10/+27
| | | | | | | | | | | | | | | | | 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.
* clarify documentation of macro keysIngo Schwarze2018-02-231-0/+23
|
* various nits found with mandoc -TlintIngo Schwarze2017-07-041-1/+1
|
* simplify the SYNOPSIS as well, just like the option lists;Ingo Schwarze2017-03-271-1/+1
| | | | suggested by and OK jmc@
* Simplify: mention at one place that -fkl override each other,Ingo Schwarze2017-03-271-10/+3
| | | | | rather than stating it separately for each option. Suggested, OKed, and tweaked by jmc@.
* For some options that are rarely needed in apropos(1) and man(1),Ingo Schwarze2017-03-251-27/+5
| | | | | | | 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@.
* Correct description of MANPATH, and a few more improvementsIngo Schwarze2017-03-181-17/+22
| | | | to the ENVIRONMENT section; OK jmc@
* Document man(1) section selection priority,Ingo Schwarze2017-03-171-2/+23
| | | | | and correct description of apropos(1) output search order. Suggested by tb@.
* add missing HISTORY informationIngo Schwarze2017-01-311-0/+4
|
* No need to hardcode /usr/bin/ as the path to more(1); helps portability.Ingo Schwarze2015-04-031-1/+2
| | | | | We don't hardcode the paths to gunzip(1) and cmp(1) either. Discussed with ajacoutot@.
* Escape punctuation characters that have a different meaning in -Tpdf.Ingo Schwarze2015-03-301-6/+6
| | | | | | | | ~, `, 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. Patch from bentley@.
* Delete the -V option. It serves no purpose but keeps confusing people.Ingo Schwarze2015-02-161-3/+1
| | | | | | | | Keeping track of the versions of installed software is the job of the package manager, not of the individual binaries. If individual binaries include version numbers, that tends to goad people into writing broken configuration tests that inspect version numbers instead of properly testing for features.
* integrate preconv(1) into mandoc(1);Ingo Schwarze2014-10-251-1/+1
| | | | enhances functionality and reduces code and docs by more than 300 lines
* Implement the traditional -h option for man(1): show the SYNOPSIS only.Ingo Schwarze2014-09-031-1/+6
| | | | | | | 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.
* Introduce a man(1) -l option as an alias for mandoc -a.Ingo Schwarze2014-08-301-3/+19
| | | | | | | | | | | | | 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.
* implement MANPAGER and PAGERIngo Schwarze2014-08-221-1/+13
|
* mandoc -a, man, apropos -a, whatis -a now paginate by defaultIngo Schwarze2014-08-221-2/+15
| | | | | but provide an option -c to not paginate; taking inspiration from manpage.c, hence adding (c) 2012 kristaps@
* Describe the new options -afkw.Ingo Schwarze2014-08-211-7/+42
| | | | Clean up the description of whatis(1).
* Complete the whatis.1 -> apropos.1 merge,Ingo Schwarze2014-08-211-6/+24
| | | | in particular regarding HISTORY and AUTHORS.
* misplaced punctuationIngo Schwarze2014-04-241-2/+2
|
* Slowly, the dust begins to settle.Ingo Schwarze2014-04-181-7/+7
| | | | | We are keeping the traditional name makewhatis(8). No content change.
* Fix a few lies; polish wording and formatting while here.Ingo Schwarze2014-04-181-23/+30
|
* remove documentation of the former macro key "NAME";Ingo Schwarze2014-04-151-1/+0
| | | | it got deleted with mansearch.h rev. 1.12
* Remember which names are in the NAME section.Ingo Schwarze2014-04-041-0/+2
| | | | | | | 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.
* merge OpenBSD rev. 1.20, describing new featuresIngo Schwarze2014-04-041-2/+20
|
* Sync to OpenBSD:Ingo Schwarze2014-03-171-55/+151
| | | | | | | | * do not talk about shell globbing * describe logical operations * improve examples * add HISTORY * some wording improvements for clarity
* Merge the relevant parts from the VERSION_1_12 branch:Ingo Schwarze2013-10-011-1/+1
| | | | | - change mandocdb.db to mandoc.db - add HISTORY to mandocdb(8)
* For citing the names and email addresses of authors,Ingo Schwarze2013-07-131-2/+1
| | | | | | | consistently use the style ".An name Aq Mt email". Triggered by a question from Jan Stary <hans at stare dot cz>, ok jmc@.
* Simple partial sync with OpenBSD:Ingo Schwarze2013-07-051-4/+4
| | | | | | | * Again accept suffixes on the name of the whatis utility. * The usage line for whatis must not invite expressions. * Revert the argument names in the SYNOPSIS back to the usual ones. * Revert a few gratuitious changes regarding line breaks etc.
* Merge whatis.1 into apropos.1 (and remove), add whatis bits to aproposKristaps Dzonsons2012-06-091-13/+19
| | | | (via mansearch), and merge mandocdb.h into mansearch.h (and remove).
* Flip apropos to use mansearch instead of apropos_db.Kristaps Dzonsons2012-06-081-92/+24
| | | | | | | | | This makes the utility much smaller and simpler. A lot of functionality has been omitted while the sqlite3 search routines improve (logical operations, etc.). It still needs work to make the output more conventional. Also add the manpage utility, which I use extensively as a mind-meld of apropos and man.
* Be insane. Make apropos(1) subsume man(1).Kristaps Dzonsons2012-03-241-10/+26
|
* State default usage before listing arguments of a utility. Inspired by aKristaps Dzonsons2011-12-251-12/+14
| | | | patch to mandocdb.8 by schwarze@ some time ago. Ok jmc@.
* Use the traditional name "whatis.db" for the mandocdb(8) databases.Ingo Schwarze2011-12-251-2/+2
| | | | Requested by deraadt@, ok kristaps@.
* Support leading, trailing and double colons in MANPATH to prepend,Kristaps Dzonsons2011-12-241-1/+12
| | | | | | | | append or insert the man.conf(5) default path; compatible with GNU manpath(1), implementation by kristaps@, heavily tweaked by schwarze@. Updates to MANPATH documentation applied to whatis.1, apropos.1, and catman.8 also.
* implement -C (alternative config file) for apropos(1) and mandocdb(8),Ingo Schwarze2011-12-121-1/+23
| | | | | including various tweaks to the whatis(8) manual; ok kristaps@
* Snip some whitespace from apropos(1) and remove mandoc(1) ref fromKristaps Dzonsons2011-11-291-1/+1
| | | | | whatis(1) (both apropos/whatis aren't related to mandoc from an operator's perspective).
* Make `-i' only apply to regular expressions. For the equality operatorKristaps Dzonsons2011-11-291-22/+16
| | | | | | (and thus the default), always use strcasestr(). Discussed on tech@ with schwarze@. While here, fix the apropos.c usage() message to be consistent with apropos(1) and clean up the EXAMPLES in apropos(1).
* Add tables of matchable keys into apropos.1. Ok and with feedback byKristaps Dzonsons2011-11-291-4/+82
| | | | schwarze@.
* Sync to OpenBSD, mostly gratuitous and whitespace differences,Ingo Schwarze2011-11-261-3/+3
| | | | | | | | | but a few serious things as well: * -M overrides MANPATH * -m prepends to the path * put back database close calls that got lost in mandocdb * missing sys/types.h in manpath.c, needed for size_t ok kristaps@
* Fix whitespace in manuals.Kristaps Dzonsons2011-11-231-2/+1
|
* Initial support for man.conf/makepath(1).Kristaps Dzonsons2011-11-201-3/+13
|
* Clarify some behaviour, bringing schwarze@'s patch and mine closer togetherKristaps Dzonsons2011-11-201-19/+11
| | | | | | | | | | | | | | | | (although I still don't have -M, which is a big piece). First, the default search path is the cwd. This will change to use -M once I look over that code. If MANPATH is specified, this replaces the cwd. Both of these are augmented by -m. If paths don't exist or don't have databases, they're silently ignored. This makes perfect sense: you may be given a superset of possible paths. The corner case of no paths (where, say, MANPATH consists of bogus paths or the cwd is unreadable) simply means that no paths are searched.
* Integrate a moderately-patched version of schwarze@'s support for multipleKristaps Dzonsons2011-11-201-3/+12
| | | | | | | | | | | directories containing mandocdb(8) databases. Some changes follow: (1) don't support -M yet; (2) fall back to cwd if no prior manpath has been specified; (3) resolve manpages using realpath() to prevent consecutive chdir()'s over relative paths; (4) note where further error-reporting is required; (5) fix leaking memory on exit in several cases.
* Evaluation with logical subexpressions. This allows support for arbitrary,Kristaps Dzonsons2011-11-181-50/+94
| | | | nested logical subexpressions with AND (-a) and OR (-o) support.
* Change getopt() to be more like schwarze@'s suggestions.Kristaps Dzonsons2011-11-091-38/+19
|
* Use `Mt' instead of `Aq' for email address.Kristaps Dzonsons2011-10-081-1/+2
|
generated by cgit (git 2.34.1) at 2024-11-11 21:08:03 +0000