![[BACK]](/icons/back.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc
Request diff between arbitrary revisions
Default branch: MAIN
Revision 1.40 / (download) - annotate - [select for diffs], Thu Aug 4 11:31:18 2022 UTC (21 months, 2 weeks 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,
HEAD
Changes since 1.39: +4 -2 lines
Diff to previous 1.39 (colored)
For clarity and consistency, refer to ".Bx 4.0" rather than ".Bx 4". Also, mention /usr/ucb/man because /usr/bin/man did not provide -f in 4.0BSD.
Revision 1.39 / (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_7_1_BASE,
OPENBSD_7_1,
OPENBSD_7_0_BASE,
OPENBSD_7_0,
OPENBSD_6_9_BASE,
OPENBSD_6_9,
OPENBSD_6_8_BASE,
OPENBSD_6_8
Changes since 1.38: +3 -4 lines
Diff to previous 1.38 (colored)
as jmc@ points out, i missed a few instances of .Xr more 1
Revision 1.38 / (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.37: +4 -4 lines
Diff to previous 1.37 (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.37 / (download) - annotate - [select for diffs], Wed Jun 17 19:41:25 2020 UTC (3 years, 11 months ago) by schwarze
Branch: MAIN
Changes since 1.36: +3 -2 lines
Diff to previous 1.36 (colored)
Manually tag the section option. Automatic tagging does not work because the [-s] flag is optional. Patch from Martin Vahlensieck.
Revision 1.36 / (download) - annotate - [select for diffs], Mon Feb 10 13:49:04 2020 UTC (4 years, 3 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_7_BASE,
OPENBSD_6_7
Changes since 1.35: +6 -3 lines
Diff to previous 1.35 (colored)
For compatibility with the man(1) implementations of the man-1.6 and man-db packages, print the manpath if the -w option is given without a following name argument. This quirk has been in man-1.6 since at least man-1.5e (1998) and in man-db since 2012. Using this feature in portable software is a dubious idea because the internal organization of manual page directories varies in about a dozen respects among operating systems, so even if you get the answer, there is no portable way to use it for looking up anything inside. However, Matej Cepl <mcepl at suse dot cz> made me aware that some software, for example the manual viewing functionality in the newest editors/neovim code, unwisely relies on this feature anyway. No objections were raised when this patch was shown on tech@.
Revision 1.35 / (download) - annotate - [select for diffs], Sat Feb 8 01:09:58 2020 UTC (4 years, 3 months ago) by jsg
Branch: MAIN
Changes since 1.34: +3 -3 lines
Diff to previous 1.34 (colored)
correct Research Unix edition "appeared in" use in HISTORY Starting from "Combined Table of Contents" in Doug McIlroy's "A Research UNIX Reader" a table of which edition manuals appeared in. Checked against manuals from bitsavers/TUHS and source from TUHS where available. Ingo points out there are cases where something is included but not documented until a later release. bcd(6) v6 v7 printf(3) v2 v4 abort(3) v5 v6 system(3) v6 v7 fmod(3) v5 v6 ok schwarze@
Revision 1.34 / (download) - annotate - [select for diffs], Tue Jan 7 11:15:12 2020 UTC (4 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.33: +48 -35 lines
Diff to previous 1.33 (colored)
Improve the description of -m/-M/MANPATH/man.conf in multiple respects after kn@ reported that the descriptions were incomplete and somewhat inaccurate. OK jmc@ kn@
Revision 1.33 / (download) - annotate - [select for diffs], Sat Mar 9 15:54:46 2019 UTC (5 years, 2 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_6_BASE,
OPENBSD_6_6,
OPENBSD_6_5_BASE,
OPENBSD_6_5
Changes since 1.32: +14 -2 lines
Diff to previous 1.32 (colored)
Mention mandoc.db(5), makewhatis(8), and weekly(8). Omission noticed by espie@ long ago, and wording tweaked by jmc@.
Revision 1.32 / (download) - annotate - [select for diffs], Thu Nov 22 11:30:15 2018 UTC (5 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.31: +10 -3 lines
Diff to previous 1.31 (colored)
In -T locale (the default), -T ascii, and -T utf8 mode, provide a new output option -O tag[=term] to move right to the definition of "term" when opening the manual page in a pager, effectively porting the -T html fragment name feature - https://man.openbsd.org/ksh#ulimit - to the terminal. Try: $ man -O tag uvm_sysctl $ man -O tag=ulimit ksh $ man -O tag 3 compress Feature development triggered by a question from kn@. Klemens also tested, provided feedback that resulted in improvements, and provided an OK.
Revision 1.31 / (download) - annotate - [select for diffs], Thu Apr 19 23:40:43 2018 UTC (6 years, 1 month ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_4_BASE,
OPENBSD_6_4
Changes since 1.30: +5 -4 lines
Diff to previous 1.30 (colored)
Tweak the description of -l: Avoid the misunderstanding that the essential purpose of -l is similar to the purpose of the -a option in mandoc(1), which is not the point: the fact that -l implies -a is merely a minor detail. The point of -l is to make man(1) behave like mandoc(1). Move the mention of -a to the end to de-emphasize it. Nate Bargmann reported that this seriously confused him, and i can see why.
Revision 1.30 / (download) - annotate - [select for diffs], Sat Aug 19 22:05:22 2017 UTC (6 years, 9 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_3_BASE,
OPENBSD_6_3,
OPENBSD_6_2_BASE,
OPENBSD_6_2
Changes since 1.29: +2 -7 lines
Diff to previous 1.29 (colored)
Delete the lie that $PAGER would only be used with -a or -l; the text was probably copied from mandoc(1) or apropos(1), where it is true.
Revision 1.29 / (download) - annotate - [select for diffs], Fri Aug 11 15:10:13 2017 UTC (6 years, 9 months ago) by schwarze
Branch: MAIN
Changes since 1.28: +12 -2 lines
Diff to previous 1.28 (colored)
Add two EXAMPLES; triggered by a question from jmc@. Feedback and OK jmc@.
Revision 1.28 / (download) - annotate - [select for diffs], Wed Aug 9 12:48:47 2017 UTC (6 years, 9 months ago) by schwarze
Branch: MAIN
Changes since 1.27: +18 -12 lines
Diff to previous 1.27 (colored)
Explain how to transform markup for the terminal when not using a pager, and how to remove markup. Add related cross references. While here, as suggested by jmc@, replace the excessive cross references to the intro pages by a more relevant one to mandoc(1). Triggered by a question from, using feedback from, and OK jmc@.
Revision 1.27 / (download) - annotate - [select for diffs], Wed May 17 23:22:29 2017 UTC (7 years ago) by schwarze
Branch: MAIN
Changes since 1.26: +2 -2 lines
Diff to previous 1.26 (colored)
Fix documentation bug: man(1) does not ignore manpath directories lacking mandoc.db(5) files; instead, it uses filename lookup to find manuals in such directories.
Revision 1.26 / (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.25: +3 -9 lines
Diff to previous 1.25 (colored)
simplify the SYNOPSIS as well, just like the option lists; suggested by and OK jmc@
Revision 1.25 / (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.24: +7 -19 lines
Diff to previous 1.24 (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.24 / (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.23: +7 -66 lines
Diff to previous 1.23 (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.23 / (download) - annotate - [select for diffs], Wed Mar 22 13:30:11 2017 UTC (7 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.22: +8 -13 lines
Diff to previous 1.22 (colored)
simplify description of -S and -w, point from EXIT STATUS to mandoc(1) for details, and remove duplicate .Xr to whatis(1); OK jmc@
Revision 1.22 / (download) - annotate - [select for diffs], Tue Mar 21 18:05:55 2017 UTC (7 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.21: +3 -9 lines
Diff to previous 1.21 (colored)
delete documentation of a hack that was removed years ago
Revision 1.21 / (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.20: +26 -7 lines
Diff to previous 1.20 (colored)
Correct description of MANPATH, and a few more improvements to the ENVIRONMENT section; OK jmc@
Revision 1.20 / (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.19: +7 -3 lines
Diff to previous 1.19 (colored)
Document man(1) section selection priority, and correct description of apropos(1) output search order. Suggested by tb@.
Revision 1.19 / (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.18: +18 -4 lines
Diff to previous 1.18 (colored)
add missing HISTORY information
Revision 1.18 / (download) - annotate - [select for diffs], Thu Jan 5 09:34:44 2017 UTC (7 years, 4 months ago) by jmc
Branch: MAIN
Changes since 1.17: +8 -8 lines
Diff to previous 1.17 (colored)
sort options list;
Revision 1.17 / (download) - annotate - [select for diffs], Tue Nov 8 17:02:21 2016 UTC (7 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.16: +15 -3 lines
Diff to previous 1.16 (colored)
document improved tagging functionality
Revision 1.16 / (download) - annotate - [select for diffs], Wed Oct 19 22:17:41 2016 UTC (7 years, 7 months ago) by schwarze
Branch: MAIN
Changes since 1.15: +4 -8 lines
Diff to previous 1.15 (colored)
Avoid the confusion that -a might require a section argument; it does not. Triggered by a question from <jmates at ee dot washington at edu>. OK jmc@.
Revision 1.15 / (download) - annotate - [select for diffs], Fri Jul 1 20:23:29 2016 UTC (7 years, 10 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_0_BASE,
OPENBSD_6_0
Changes since 1.14: +7 -31 lines
Diff to previous 1.14 (colored)
Update and simplify the documentation of the -s option, which was forgotten when implementing the new man.conf(5) format. The outdated information was originally pointed out by Andy Bradford <amb dash openbsd at bradfords dot org> on misc@. OK jmc@
Revision 1.14 / (download) - annotate - [select for diffs], Mon Sep 21 09:58:42 2015 UTC (8 years, 7 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_9_BASE,
OPENBSD_5_9
Changes since 1.13: +2 -20 lines
Diff to previous 1.13 (colored)
no more _subdir; Jan Stary <hans at stare dot cz>
Revision 1.13 / (download) - annotate - [select for diffs], Fri Jul 17 22:35:36 2015 UTC (8 years, 10 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_8_BASE,
OPENBSD_5_8
Changes since 1.12: +9 -2 lines
Diff to previous 1.12 (colored)
Initial, still somewhat experimental implementation to leverage less(1) -T and :t ctags(1)-like functionality to jump to the definitions of various terms inside manual pages. To be polished in the tree, so bear with me and report issues. Technically, if less(1) is used as a pager, information is collected by the mdoc(7) terminal formatter, first stored using the ohash library, then ultimately written to a temporary file which is passed to less via -T. No change intended for other output formatters or when running without a pager. Based on an idea from Kristaps using feedback from many, in particular phessler@ nicm@ millert@ halex@ doug@ kspillner@ deraadt@.
Revision 1.12 / (download) - annotate - [select for diffs], Fri Apr 3 08:45:27 2015 UTC (9 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.11: +4 -3 lines
Diff to previous 1.11 (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.11 / (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.10: +4 -6 lines
Diff to previous 1.10 (colored)
Delete the -V option. It serves no purpose but keeps confusing people.
Revision 1.10 / (download) - annotate - [select for diffs], Tue Jan 20 21:12:46 2015 UTC (9 years, 3 months ago) by schwarze
Branch: MAIN
Changes since 1.9: +5 -4 lines
Diff to previous 1.9 (colored)
Split the -Werror message level into -Werror (broken manual, probably using mandoc is better than using groff) and -Wunsupp (manual using unsupported low-level roff(7) feature, probably using groff is better than using mandoc). Once this feature is complete, it is intended to help porting, making the decision whether to USE_GROFF easier. As a first step, distinguish four classes of roff(7) requests: 1. Supported (currently 24 requests) 2. Currently ignored because unimportant (120) -> no message 3. Ignored for good because insecure (14) -> -Werror 4. Currently unsupported (68) -> these trigger the new -Wunsupp messages
Revision 1.9 / (download) - annotate - [select for diffs], Thu Jan 15 04:26:06 2015 UTC (9 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.8: +8 -8 lines
Diff to previous 1.8 (colored)
Fatal errors no longer exist. If a file can be opened, mandoc will produce some output; at worst, the output may be almost empty. Simplifies error handling and frees a message type for future use.
Revision 1.8 / (download) - annotate - [select for diffs], Sun Dec 28 14:39:08 2014 UTC (9 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.7: +5 -2 lines
Diff to previous 1.7 (colored)
mdoc(7) already uses the mandoc(1) -Ios argument in the footer line when .Os has no argument, so do the same for man(7) when .TH has less than four arguments; there is no reason to treat both differently. Issue found following a question from Thomas Klausner <wiz at NetBSD>.
Revision 1.7 / (download) - annotate - [select for diffs], Thu Dec 18 20:45:50 2014 UTC (9 years, 5 months ago) by jmc
Branch: MAIN
Changes since 1.6: +3 -3 lines
Diff to previous 1.6 (colored)
update usage() and the list of non-standard (i.e. non-posix) options; ok schwarze
Revision 1.6 / (download) - annotate - [select for diffs], Sun Dec 14 17:48:48 2014 UTC (9 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.5: +67 -10 lines
Diff to previous 1.5 (colored)
minimally document -IOKTW; requested by naddy@
Revision 1.5 / (download) - annotate - [select for diffs], Tue Nov 11 02:43:11 2014 UTC (9 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.4: +5 -3 lines
Diff to previous 1.4 (colored)
Let -h imply -c (that is, not use the pager). Usually, -h output is short, so the pager is just a nuisance. Also, traditional man(1) does not use a pager for -h. Triggered by a remark of deraadt@ on ICB.
Revision 1.4 / (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.3: +3 -3 lines
Diff to previous 1.3 (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.3 / (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.2: +5 -6 lines
Diff to previous 1.2 (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.2 / (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.1: +36 -4 lines
Diff to previous 1.1 (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.1 / (download) - annotate - [select for diffs], Wed Aug 27 00:06:08 2014 UTC (9 years, 8 months ago) by schwarze
Branch: MAIN
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.