summaryrefslogtreecommitdiffstats
path: root/mandoc.1
Commit message (Collapse)AuthorAgeFilesLines
* 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
* sort options list; from jmc@Ingo Schwarze2017-01-061-4/+4
|
* correct spelling error; from jmc@Ingo Schwarze2016-12-281-1/+1
|
* Make the second, section number argument of .Xr mandatory.Ingo Schwarze2016-12-281-0/+7
| | | | | | In fact, we have been requiring it for many years. The only reason to not warn when it was missing was excessive traditionalism - it was optional in 4.4BSD.
* Unify the three stylesheets into a single CSS file.Ingo Schwarze2015-11-051-3/+3
| | | | Many thanks to bentley@ for doing this work.
* If a .Bd block has no arguments at all, drop the block and only keepIngo Schwarze2015-10-301-0/+7
| | | | | its contents. Removing a gratuitious difference to groff output found after a related bug report from krw@.
* improve wording and start a new sentence on a new line; from jmc@Ingo Schwarze2015-10-061-2/+3
|
* briefly document -T tree outputIngo Schwarze2015-09-261-0/+40
|
* Remove the warning about children of .Vt blocks because actually,Ingo Schwarze2015-09-141-7/+0
| | | | | | | .Vt type global_variable No = Dv defined_constant ; is the best way to specify in the SYNOPSIS how a global variable is initialized in the rare case where that matters. Issue noticed by jmc@.
* 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-1/+1
| | | | | | | | ~, `, 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@.
* refering -> referring; patch from jmc@Ingo Schwarze2015-03-271-1/+1
|
* Modernize documentation by inserting blanks between option lettersIngo Schwarze2015-03-271-56/+53
| | | | | | and option arguments, except for -m because "-m an" and "-m andoc" look just too weird. Of course, the traditional form without the blank will continue to work.
* improve NAME section diagnostics;Ingo Schwarze2015-02-231-8/+18
| | | | confusing messages reported by Jan Stary <hans at stare dot cz>
* clean up post_dt() validation function;Ingo Schwarze2015-02-161-0/+3
| | | | improved diagnostics, minus six lines of code