summaryrefslogtreecommitdiffstats
path: root/mandoc.1
Commit message (Collapse)AuthorAgeFilesLines
* For -Tlint, put parser messages on stdout instead of stderr.Ingo Schwarze2017-07-201-1/+3
| | | | | | | | | | | Originally, naddy@ requested this in 2011 (or maybe even earlier). It was discussed with joerg@, kristaps@, naddy@, and espie@ in 2011, and everybody agreed in principle, but it was postponed because kristaps@ wanted to do some cleanup of the message system first. Meanwhile, message infrastructure was improved about a dozen times... This makes long, tedious commands like "mandoc -Tlint *.1 2>&1 | less" unnecessary and allows simple ones like "man -l -Tlint *.1".
* Radically simplify the definitions what the message levels ERRORIngo Schwarze2017-07-071-25/+6
| | | | and WARNING mean: minus 20 lines of mdoc source. OK jmc@.
* Now that we have the -Wstyle message level, downgrade six warningsIngo Schwarze2017-07-061-56/+56
| | | | | | that are not syntax mistakes and that do not cause wrong formatting or content to style suggestions. Also upgrade two warnings that may cause information loss to errors.
* Printing "BASE:" in messages about violations of base system conventionsIngo Schwarze2017-07-041-0/+6
| | | | | is confusing, simply print "STYLE:", which is intuitive and does not sound excessively alarming; suggested by jmc@, OK tedu@ jmc@.
* report trailing delimiters after macros where they are usually a mistake;Ingo Schwarze2017-07-031-4/+8
| | | | the idea came up in a discussion with Thomas Klausner <wiz at NetBSD>
* warn about time machines; suggested by Thomas Klausner <wiz @ NetBSD>Ingo Schwarze2017-07-031-0/+8
|
* add warning "cross reference to self"; inspired by mdoclintIngo Schwarze2017-07-021-0/+18
|
* Basic reporting of .Xrs to manual pages that don't existIngo Schwarze2017-07-011-0/+8
| | | | | | | | | | | | in the base system, inspired by mdoclint(1). We are able to do this because (1) the -mdoc parser, the -Tlint validator, and the man(1) manual page lookup code are all in the same program and (2) the mandoc.db(5) database format allows fast lookup. Feedback from, previous versions tested by, and OK jmc@. A few features will be added to this in the tree, step by step.
* warn about some non-portable idioms in .Bl -column;Ingo Schwarze2017-06-291-0/+17
| | | | triggered by a question from Yuri Pankov (illumos)
* warn about .Ns macros that have no effect because they are followedIngo Schwarze2017-06-271-1/+3
| | | | by an isolated closing delimiter; inspired by mdoclint
* Catch typos in .Sh names; suggested by jmc@.Ingo Schwarze2017-06-251-0/+5
| | | | | | I'm using a very simple, linear time / zero space fuzzy string matching heuristic rather than a full Levenshtein metric, to keep the code both simple and fast.
* add support for the MT and ME mailto macros, used for example in wg(8);Ingo Schwarze2017-06-251-2/+6
| | | | patch from bentley@
* delete useless .Ns macro that jmc@ found with mdoclint(1)Ingo Schwarze2017-06-241-1/+1
|
* document message "unknown architecture"Ingo Schwarze2017-06-241-0/+6
|
* in the base system, suggest leaving .Os blank; inspired by mdoclintIngo Schwarze2017-06-241-0/+6
|
* Split -Wstyle into -Wstyle and the even lower -Wbase, and addIngo Schwarze2017-06-241-28/+69
| | | | | | | | | | | | | | | -Wopenbsd and -Wnetbsd to check conventions for the base system of a specific operating system. Mark operating system specific messages with "(OpenBSD)" at the end. Please use just "-Tlint" to check base system manuals (defaulting to -Wall, which is now -Wbase), but prefer "-Tlint -Wstyle" for the manuals of portable software projects you maintain that are not part of OpenBSD base, to avoid bogus recommendations about base system conventions that do not apply. Issue originally reported by semarie@, solution using an idea from tedu@, discussed with jmc@ and jca@.
* style message about duplicate RCS ids; inspired by mdoclintIngo Schwarze2017-06-171-0/+5
|
* style message about missing RCS ids; inspired by mdoclintIngo Schwarze2017-06-171-0/+42
|
* Delete the arbitrary range restriction for -Owidth.Ingo Schwarze2017-06-131-2/+1
| | | | | | | We provide users with tools. We don't attempt to prevent them from using them in stupid ways: depending on the context, not every stupid-looking use is necessarily actually stupid, and not every stupidity can be automatically detected anyway, so don't even try.
* style message about missing .Fn markup; inspired by mdoclintIngo Schwarze2017-06-111-0/+9
|
* style message about missing blank before trailing delimiter;Ingo Schwarze2017-06-101-0/+5
| | | | inspired by mdoclint(1), and jmc@ considers it useful
* warning about unknown .Lb arguments; inspired by mdoclint(1)Ingo Schwarze2017-06-081-0/+6
|
* style checks related to .Er; inspired by mdoclint(1)Ingo Schwarze2017-06-071-0/+30
|
* Minimal implementation of the roff(7) .ce request (center a numberIngo Schwarze2017-06-061-0/+5
| | | | | of input lines without filling). Contrary to groff, high-level macros abort .ce mode for now.
* enable -Wstyle by default in -Tlint; OK jmc@Ingo Schwarze2017-06-031-2/+2
|
* STYLE message about full stop at the end of .Nd; inspired by mdoclint(1)Ingo Schwarze2017-06-011-0/+5
|
* STYLE message about missing use of Ox/Nx/Fx/Dx; OK jmc@ wiz@Ingo Schwarze2017-05-311-0/+10
|
* tweak previous; from jmc@Ingo Schwarze2017-05-301-2/+2
|
* STYLE message about useless macros we don't want (Bt Tn Ud);Ingo Schwarze2017-05-301-0/+12
| | | | not a WARNING because they don't endanger portability
* Delete the -T xhtml command line option.Ingo Schwarze2017-05-171-3/+0
| | | | | It has been obsolete for more than two years. Use -T html.
* Modernize an example showing antiquated syntax,Ingo Schwarze2017-05-171-2/+1
| | | | and delete an example showing the arcane -W stop option.
* missing space between macro arg and punctuation; from jmc@Ingo Schwarze2017-05-171-1/+1
|
* Introduce a new mandoc(1) message level, -W style, below -W warning.Ingo Schwarze2017-05-161-11/+30
| | | | | | | | | | | | | Switch -W all from meaning -W warning to meaning -W style. The meaning of -T lint does *not* change, it still implies -W warning. No messages on the new level yet, but they will come. Usually, i do not lightly make the user interface larger. But this has been planned for years, and EXIT STATUS 1 was reserved for it all the time. The message system is now stable enough to finally implement it. jmc@ regarding the concept: "really good idea"
* simplify the SYNOPSIS as well, just like the option lists;Ingo Schwarze2017-03-271-3/+3
| | | | suggested by and OK jmc@
* For some options that are rarely needed in mandoc(1),Ingo Schwarze2017-03-271-14/+4
| | | | | delete the descriptions and point to man(1) instead. Inspired by apropos.1 rev. 1.43.
* Simplify: mention at one place that -fkl override each other,Ingo Schwarze2017-03-271-15/+3
| | | | | rather than stating it separately for each option. Suggested, OKed, and tweaked by jmc@.
* simplify .Nd; to display manuals, use man(1) instead;Ingo Schwarze2017-03-211-1/+1
| | | | OK jmc@
* Silently ignore invalid -m input formats rather than erroring out.Ingo Schwarze2017-03-201-59/+29
| | | | | | As observed by Jan Stary <hans at stare dot cz>, this is useful such that after 'alias man="man -m $HOME/man"', 'man -l foo.1' still works. Simplify and shorten the description of -m, and use .Ic for macros.
* Correct description of MANPATH, and a few more improvementsIngo Schwarze2017-03-181-3/+16
| | | | to the ENVIRONMENT section; OK jmc@
* Document that -T markdown produces ASCII output, and the impliedIngo Schwarze2017-03-081-0/+10
| | | | | | | | limitations. Of course, we could write UTF-8 output instead, but even the CommonMark specification doesn't require parsers to support that, so portability would be doubtful. While here, provide a link to the CommonMark specification.
* Using .Nd only makes sense in the NAME section.Ingo Schwarze2017-03-061-0/+8
| | | | | Warn if that macro occurs elsewhere. Triggered by a question from Dag-Erling Smoergrav <des @ FreeBSD>.
* Make the description of -K autodetection easer to understand.Ingo Schwarze2017-03-041-11/+19
| | | | Basic idea suggested by jmc@, OK jmc@.
* new -mdoc -Tmarkdown output mode; OK millert@ reyk@ tb@;Ingo Schwarze2017-03-031-1/+31
| | | | thanks to reyk@ and to Vsevolod at FreeBSD for suggesting it
* In -Ttree output mode, show the BROKEN node flag andIngo Schwarze2017-02-101-0/+13
| | | | provide a -Onoval output option to show the unvalidated tree.
* add missing HISTORY informationIngo Schwarze2017-01-311-0/+13
|
* Add a warning "new sentence, new line".Ingo Schwarze2017-01-281-0/+4
| | | | | | | | | This does not attempt to pinpoint each and every offender, but instead tries very hard to avoid false positives: Currently, there are only two false positives in the whole OpenBSD base system. Only do this in mdoc(7), not in man(7), because manuals written in man(7) typically have much worse problems than this. OK jmc@ on a previous version of the patch
* bug was fixed, delete the BUGS sectionIngo Schwarze2017-01-211-9/+0
|
* show meta data for -Ttree outputIngo Schwarze2017-01-121-1/+9
|
* Introduce flags NODE_NOSRC and NODE_NOPRT for AST nodes.Ingo Schwarze2017-01-101-0/+6
| | | | | | | | | Use them to mark generated nodes and nodes that shall not produce output. Let -Ttree output mode display these new flags. Use NODE_NOSRC for .Ar, .Mt, and .Pa default arguments. Use NODE_NOPRT for .Dd, .Dt, and .Os. These will help to make handling of text production macros more rigorous.
* Stricter validation of the NAME section, in particular:Ingo Schwarze2017-01-081-5/+12
| | | | | | | - require a comma between names - reject all other text nodes - reject all empty Nm below NAME, not only in the leading position - reject Nm after Nd
generated by cgit (git 2.34.1) at 2024-11-18 10:46:14 +0000