CVS log for mandoc/man.1

[BACK] Up to [cvsweb.bsd.lv] / mandoc

Request diff between arbitrary revisions


Default branch: MAIN


Revision 1.40 / (download) - annotate - [select for diffs], Mon Jul 20 16:57:30 2020 UTC (2 weeks, 6 days ago) by schwarze
Branch: MAIN
CVS Tags: HEAD
Changes since 1.39: +5 -6 lines
Diff to previous 1.39 (colored)

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

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.

Revision 1.39 / (download) - annotate - [select for diffs], Wed Jun 17 19:42:32 2020 UTC (7 weeks, 4 days ago) by schwarze
Branch: MAIN
Changes since 1.38: +2 -1 lines
Diff to previous 1.38 (colored)

Manually tag the section option.
Automatic tagging does not work because the [-s] flag is optional.
Patch from Martin Vahlensieck.

Revision 1.38 / (download) - annotate - [select for diffs], Mon Feb 10 14:04:11 2020 UTC (5 months, 4 weeks ago) by schwarze
Branch: MAIN
Changes since 1.37: +3 -3 lines
Diff to previous 1.37 (colored)

The man(1) command was already available in AT&T Version 2 UNIX.
Jonathan Gray found it in the "Combined Table of Contents" in Doug
McIlroy's "A Research UNIX Reader", which contains a table of which
edition manuals appeared in, and in both the "Table of Contents"
(page vi) and the body (page 89) of the printed UNIX Programmer's
Manual (June 12, 1972) from bitsavers.

Revision 1.37 / (download) - annotate - [select for diffs], Mon Feb 10 13:49:15 2020 UTC (5 months, 4 weeks ago) by schwarze
Branch: MAIN
Changes since 1.36: +6 -3 lines
Diff to previous 1.36 (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.36 / (download) - annotate - [select for diffs], Tue Jan 7 11:16:33 2020 UTC (7 months ago) by schwarze
Branch: MAIN
Changes since 1.35: +48 -35 lines
Diff to previous 1.35 (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.35 / (download) - annotate - [select for diffs], Sat Mar 9 15:55:01 2019 UTC (17 months ago) by schwarze
Branch: MAIN
CVS Tags: VERSION_1_14_5
Changes since 1.34: +14 -2 lines
Diff to previous 1.34 (colored)

Mention mandoc.db(5), makewhatis(8), and weekly(8).
Omission noticed by espie@ long ago, and wording tweaked by jmc@.

Revision 1.34 / (download) - annotate - [select for diffs], Thu Nov 22 11:30:23 2018 UTC (20 months, 2 weeks ago) by schwarze
Branch: MAIN
Changes since 1.33: +10 -3 lines
Diff to previous 1.33 (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.33 / (download) - annotate - [select for diffs], Thu Apr 19 23:41:16 2018 UTC (2 years, 3 months ago) by schwarze
Branch: MAIN
CVS Tags: VERSION_1_14_4
Changes since 1.32: +5 -4 lines
Diff to previous 1.32 (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.32 / (download) - annotate - [select for diffs], Sat Aug 19 22:05:38 2017 UTC (2 years, 11 months ago) by schwarze
Branch: MAIN
Changes since 1.31: +2 -7 lines
Diff to previous 1.31 (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.31 / (download) - annotate - [select for diffs], Fri Aug 11 15:10:26 2017 UTC (2 years, 11 months ago) by schwarze
Branch: MAIN
Changes since 1.30: +12 -2 lines
Diff to previous 1.30 (colored)

Add two EXAMPLES; triggered by a question from jmc@.
Feedback and OK jmc@.

Revision 1.30 / (download) - annotate - [select for diffs], Wed Aug 9 12:49:04 2017 UTC (3 years ago) by schwarze
Branch: MAIN
Changes since 1.29: +18 -12 lines
Diff to previous 1.29 (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.29 / (download) - annotate - [select for diffs], Wed May 17 23:23:00 2017 UTC (3 years, 2 months ago) by schwarze
Branch: MAIN
CVS Tags: VERSION_1_14_3, VERSION_1_14_2
Changes since 1.28: +2 -2 lines
Diff to previous 1.28 (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.28 / (download) - annotate - [select for diffs], Mon Mar 27 18:51:36 2017 UTC (3 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.27: +3 -9 lines
Diff to previous 1.27 (colored)

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

Revision 1.27 / (download) - annotate - [select for diffs], Mon Mar 27 14:40:39 2017 UTC (3 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.26: +7 -19 lines
Diff to previous 1.26 (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.26 / (download) - annotate - [select for diffs], Sat Mar 25 12:46:36 2017 UTC (3 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.25: +7 -66 lines
Diff to previous 1.25 (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.25 / (download) - annotate - [select for diffs], Wed Mar 22 13:31:49 2017 UTC (3 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.24: +8 -13 lines
Diff to previous 1.24 (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.24 / (download) - annotate - [select for diffs], Tue Mar 21 18:06:12 2017 UTC (3 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.23: +3 -9 lines
Diff to previous 1.23 (colored)

delete documentation of a hack that was removed years ago

Revision 1.23 / (download) - annotate - [select for diffs], Sat Mar 18 19:51:19 2017 UTC (3 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.22: +26 -7 lines
Diff to previous 1.22 (colored)

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

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

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

Revision 1.21 / (download) - annotate - [select for diffs], Tue Jan 31 19:44:04 2017 UTC (3 years, 6 months ago) by schwarze
Branch: MAIN
CVS Tags: VERSION_1_14_1, VERSION_1_13
Changes since 1.20: +18 -4 lines
Diff to previous 1.20 (colored)

add missing HISTORY information

Revision 1.20 / (download) - annotate - [select for diffs], Fri Jan 6 01:34:57 2017 UTC (3 years, 7 months ago) by schwarze
Branch: MAIN
Changes since 1.19: +8 -8 lines
Diff to previous 1.19 (colored)

sort options list; from jmc@

Revision 1.19 / (download) - annotate - [select for diffs], Tue Nov 8 17:05:29 2016 UTC (3 years, 9 months ago) by schwarze
Branch: MAIN
Changes since 1.18: +15 -3 lines
Diff to previous 1.18 (colored)

document improved tagging functionality

Revision 1.18 / (download) - annotate - [select for diffs], Wed Oct 19 22:20:36 2016 UTC (3 years, 9 months ago) by schwarze
Branch: MAIN
Changes since 1.17: +4 -8 lines
Diff to previous 1.17 (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.17 / (download) - annotate - [select for diffs], Fri Jul 1 20:24:04 2016 UTC (4 years, 1 month ago) by schwarze
Branch: MAIN
CVS Tags: VERSION_1_13_4
Changes since 1.16: +7 -31 lines
Diff to previous 1.16 (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.16 / (download) - annotate - [select for diffs], Mon Sep 21 09:59:02 2015 UTC (4 years, 10 months ago) by schwarze
Branch: MAIN
Changes since 1.15: +2 -20 lines
Diff to previous 1.15 (colored)

no more _subdir; Jan Stary <hans at stare dot cz>

Revision 1.15 / (download) - annotate - [select for diffs], Fri Jul 17 22:38:29 2015 UTC (5 years ago) by schwarze
Branch: MAIN
Changes since 1.14: +9 -2 lines
Diff to previous 1.14 (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.14 / (download) - annotate - [select for diffs], Fri Apr 3 08:46:17 2015 UTC (5 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.13: +4 -3 lines
Diff to previous 1.13 (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.13 / (download) - annotate - [select for diffs], Mon Feb 16 16:23:54 2015 UTC (5 years, 5 months ago) by schwarze
Branch: MAIN
CVS Tags: VERSION_1_13_3
Changes since 1.12: +4 -6 lines
Diff to previous 1.12 (colored)

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

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.

Revision 1.12 / (download) - annotate - [select for diffs], Tue Jan 20 21:16:51 2015 UTC (5 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.11: +5 -4 lines
Diff to previous 1.11 (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.11 / (download) - annotate - [select for diffs], Thu Jan 15 04:26:40 2015 UTC (5 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.10: +8 -8 lines
Diff to previous 1.10 (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.10 / (download) - annotate - [select for diffs], Sun Dec 28 14:42:27 2014 UTC (5 years, 7 months ago) by schwarze
Branch: MAIN
Changes since 1.9: +5 -2 lines
Diff to previous 1.9 (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.9 / (download) - annotate - [select for diffs], Thu Dec 18 21:11:46 2014 UTC (5 years, 7 months ago) by schwarze
Branch: MAIN
Changes since 1.8: +3 -3 lines
Diff to previous 1.8 (colored)

update usage() and the list of non-standard (i.e. non-posix) options;
from jmc@

Revision 1.8 / (download) - annotate - [select for diffs], Wed Dec 17 20:04:23 2014 UTC (5 years, 7 months ago) by schwarze
Branch: MAIN
Changes since 1.7: +67 -10 lines
Diff to previous 1.7 (colored)

minimally document -IOKTW; requested by naddy@

Revision 1.7 / (download) - annotate - [select for diffs], Tue Nov 11 02:43:41 2014 UTC (5 years, 9 months ago) by schwarze
Branch: MAIN
CVS Tags: VERSION_1_13_2
Changes since 1.6: +5 -3 lines
Diff to previous 1.6 (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.6 / (download) - annotate - [select for diffs], Sat Oct 25 01:03:52 2014 UTC (5 years, 9 months ago) by schwarze
Branch: MAIN
Changes since 1.5: +3 -3 lines
Diff to previous 1.5 (colored)

integrate preconv(1) into mandoc(1);
enhances functionality and reduces code and docs by more than 300 lines

Revision 1.5 / (download) - annotate - [select for diffs], Wed Sep 3 05:22:45 2014 UTC (5 years, 11 months ago) by schwarze
Branch: MAIN
Changes since 1.4: +5 -6 lines
Diff to previous 1.4 (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.4 / (download) - annotate - [select for diffs], Sat Aug 30 18:08:10 2014 UTC (5 years, 11 months ago) by schwarze
Branch: MAIN
Changes since 1.3: +34 -2 lines
Diff to previous 1.3 (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.3 / (download) - annotate - [select for diffs], Thu Aug 21 02:38:24 2014 UTC (5 years, 11 months ago) by schwarze
Branch: MAIN
Changes since 1.2: +9 -1 lines
Diff to previous 1.2 (colored)

man -I -O -T -W now work, too

Revision 1.2 / (download) - annotate - [select for diffs], Thu Aug 21 01:35:43 2014 UTC (5 years, 11 months ago) by schwarze
Branch: MAIN
Changes since 1.1: +18 -51 lines
Diff to previous 1.1 (colored)

* remove pointless separate -f and -k synopses, they take almost all args
* fix up descriptions of -f and -k
* remove excessive example for -k
* remove explicit BSD references
* add CVS Id

Revision 1.1 / (download) - annotate - [select for diffs], Thu Aug 21 00:42:38 2014 UTC (5 years, 11 months ago) by schwarze
Branch: MAIN

Now that we have man(1) functionality, add a man(1) manual page.
I'm importing the totally unchanged OpenBSD version
such that all changes can easily be tracked in CVS.

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.




CVSweb