summaryrefslogtreecommitdiffstats
path: root/usr.bin/mandoc/mandoc.1 (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Ignore unreasonably large spacing modifiers in tbl layouts.schwarze2020-09-011-2/+6
| | | | | | Jan Schreiber <jes at posteo dot de> ran afl on mandoc and it turned out mandoc tried to use spacing modifiers so large that they would trigger assertion failures in term_ascii.c, function locale_advance().
* Remove a lie reported by Jamie Landeg-Jones <jamie at catflap dot org>:schwarze2020-08-271-5/+2
| | | | | The times when -T man may have expanded .so requests are long gone, nor would such a feature be useful. Use soelim(1) if you need that.
* Make it more explicit that the statement "-O tag does not work with less(1)"schwarze2020-08-271-3/+10
| | | | | | only applies to -T html output mode, and why. Of course, -O tag works just fine with less(1) in the -T ascii and -T utf8 output modes. Potential for confusion pointed out by Ian Ropers.
* as jmc@ points out, i missed a few instances of .Xr more 1schwarze2020-07-201-4/+3
|
* Switch the default pager from "more -s" to "less".schwarze2020-07-201-4/+4
| | | | | | | | | | | | | | | | | | | 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@
* document -T html -O tag as implemented in main.c rev. 1.253schwarze2020-06-151-2/+19
|
* provide a STYLE message when mandoc knows the file name and the extensionschwarze2020-04-241-3/+17
| | | | | disagrees with the section number given in the .Dt or .TH macro; feature suggested and patch tested by jmc@
* mention that -T man does not support eqn(7) and tbl(7);schwarze2020-02-151-3/+8
| | | | triggered by a question from Stephen Gregoratto <dev at sgregoratto dot me>
* Align to the new, sane behaviour of the groff_mdoc(7) .Dd macro:schwarze2020-01-191-3/+3
| | | | | | | | without an argument, use the empty string, and always concatenate all arguments, no matter their number. This allows reducing the number of arguments of mandoc_normdate() and some other simplifications, at the same time polishing some error messages by adding the name of the macro in question.
* Some time ago, i simplified mandoc_msg() such that it can be usedschwarze2019-07-101-6/+49
| | | | | | | | | everywhere and not only in the parsers. For more uniform messages, use it at more places instead of err(3), in particular in the main program. While here, integrate a few trivial functions called at exactly one place into the main option parser, and let a few more functions use the normal convention of returning 0 for success and -1 for error.
* use proper crossreferencesnaddy2019-05-261-3/+4
|
* improve the description of the message "blank line in fill mode";schwarze2019-04-301-3/+6
| | | | triggered by a misunderstanding by sashan@
* Explain the ASCII rendering of single quotes because that repeatedlyschwarze2019-02-231-2/+13
| | | | | | | | | | | caused confusion in the past. People plainly do not expect that there are limits to the compatibility between Unicode and ASCII, but there are. The information belongs here and not into mandoc_char(7) because it explains how the specific output device (-T ascii) works and because it has nothing to do with the question of how characters are represented on the input side.
* Support taking the -O tag value from apropos(1) key=value search terms;schwarze2019-01-011-4/+12
| | | | | | feature improvement suggested by kn@. While here, also make "-O value" work from standard input. OK kn@
* add some notes about using col and ul to process the ascii markuptedu2018-12-271-2/+9
| | | | | since these may not be commonly known utilities. with schwarze
* mandoc.css lives in /usr/share/misc now; use full paths to indicate this.tedu2018-12-241-9/+9
| | | | ok schwarze
* Explain what the fields in mandoc messages mean,schwarze2018-12-201-5/+21
| | | | | | rather than merely specifying the message syntax. Gap in documentation found while looking at a bug report from Raf Czlonka <rczlonka at gmail dot com>.
* Several improvements to escape sequence handling.schwarze2018-12-151-3/+17
| | | | | | | | | | | | | | | | | | | | | | | * Add the missing special character \_ (underscore). * Partial implementations of \a (leader character) and \E (uninterpreted escape character). * Parse and ignore \r (reverse line feed). * Add a WARNING message about undefined escape sequences. * Add an UNSUPP message about unsupported escape sequences. * Mark \! and \? (transparent throughput) and \O (suppress output) as unsupported. * Treat the various variants of zero-width spaces as one-byte escape sequences rather than as special characters, to avoid defining bogus forms with square brackets. * For special characters with one-byte names, do not define bogus forms with square brackets, except for \[-], which is valid. * In the form with square brackets, undefined special characters do not fall back to printing the name verbatim, not even for one-byte names. * Starting a special character name with a blank is an error. * Undefined escape sequences never abort formatting of the input string, not even in HTML output mode. * Document the newly handled escapes, and a few that were missing. * Regression tests for most of the above.
* In -T locale (the default), -T ascii, and -T utf8 mode, provide a newschwarze2018-11-221-2/+14
| | | | | | | | | | | | | | | 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.
* Add an option -T html -O toc to add a brief table of contents nearschwarze2018-10-021-1/+4
| | | | | the top of HTML pages containing at least two non-standard sections. Suggested by Adam Kalisz and discussed with kristaps@ during EuroBSDCon 2018.
* Support a second argument to -O man,schwarze2018-10-021-3/+7
| | | | | | selecting the format according to local existence of the file. Suggested by kristaps@ during EuroBSDCon 2018. Written on the train Frankfurt-Karlsruhe returning from EuroBSDCon.
* Rudimentary implementation of the roff(7) .char (output glyphschwarze2018-08-251-2/+15
| | | | | | | | | definition) request, used for example by groff_hdtbl(7). This simplistic implementation may interact incorrectly with the .tr (input character translation) request. But come on, you are not only using .char *and* .tr, but you do so with respect to the same character in the same manual page?
* Implement the roff(7) .shift and .return requests,schwarze2018-08-231-2/+24
| | | | | | | | | | | | | | for example used by groff_hdtbl(7) and groff_mom(7). Also correctly interpolate arguments during nested macro execution even after .shift and .return, implemented using a stack of argument arrays. Note that only read.c, but not roff.c can detect the end of a macro execution, and the existence of .shift implies that arguments cannot be interpolated up front, so unfortunately, this includes a partial revert of roff.c rev. 1.209, moving argument interpolation back into the function roff_res().
* Issue a STYLE message when normalizing the date format in .Dd/.TH.schwarze2018-07-281-2/+12
| | | | | | | | Leah Neukirchen pointed out that mdoclint(1) used to warn about a leading zero before the day number, so we know that both NetBSD and Void Linux want the message. It does no harm on OpenBSD because Mdocdate always does the right thing anyway. jmc@ agrees that it makes sense in contexts not using Mdocdate.
* Minor correction: we render HTML character references hexadecimal,schwarze2018-05-031-3/+3
| | | | not decimal; bentley@ changed that in html.c on July 14, 2017.
* Simpler description of output formats, shortening the manual page by 15 lines.schwarze2018-04-291-101/+87
| | | | | | | Avoid the double redirection from -Tutf8 via -Tlocale to -Tascii. Add LC_CTYPE to the ENVIRONMENT section. While here, also correct a few inaccuracies and tweak some wordings. Triggered by a question from Laura Morales <lauretas at mail dot com>.
* Use TIOCGWINSZ to reduce the default -Owidth during interactive useschwarze2018-04-131-6/+10
| | | | | | | on terminals narrower than 79 columns and the default -Oindent on terminals narrower than 66 columns. Requested by and feedback from pirofti@; mpi@ and juanfra@ also like the general direction.
* Style message about bad input encoding of em-dashes as -- instead of \(em.schwarze2018-03-161-3/+9
| | | | Suggested by Thomas Klausner <wiz at NetBSD>; discussed with jmc@.
* duplicate word, found by igor(1)schwarze2017-11-281-3/+3
|
* Be less assertive when warning about a possible typo.jca2017-11-101-3/+3
| | | | ok schwarze@ "good compromise" jmc@
* typo: convertion -> conventiondcoppa2017-09-071-3/+3
| | | | OK schwarze@
* document -O mdoc; triggered by a question from jmc@ and OK jmc@schwarze2017-08-191-2/+16
|
* For -Tlint, put parser messages on stdout instead of stderr.schwarze2017-07-201-3/+5
| | | | | | | | | | | 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 ERRORschwarze2017-07-071-27/+8
| | | | and WARNING mean: minus 20 lines of mdoc source. OK jmc@.
* Now that we have the -Wstyle message level, downgrade six warningsschwarze2017-07-061-58/+58
| | | | | | 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 conventionsschwarze2017-07-041-2/+8
| | | | | 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;schwarze2017-07-031-5/+9
| | | | the idea came up in a discussion with Thomas Klausner <wiz at NetBSD>
* warn about time machines; suggested by Thomas Klausner <wiz @ NetBSD>schwarze2017-07-031-2/+10
|
* add warning "cross reference to self"; inspired by mdoclintschwarze2017-07-021-2/+20
|
* Basic reporting of .Xrs to manual pages that don't existschwarze2017-07-011-2/+10
| | | | | | | | | | | | 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;schwarze2017-06-291-2/+19
| | | | triggered by a question from Yuri Pankov (illumos)
* warn about .Ns macros that have no effect because they are followedschwarze2017-06-271-3/+5
| | | | by an isolated closing delimiter; inspired by mdoclint
* Catch typos in .Sh names; suggested by jmc@.schwarze2017-06-251-1/+6
| | | | | | 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).bentley2017-06-251-4/+8
| | | | feedback and ok schwarze@
* delete useless .Ns macro that jmc@ found with mdoclint(1)schwarze2017-06-241-2/+2
|
* document message "unknown architecture"schwarze2017-06-241-1/+7
|
* in the base system, suggest leaving .Os blank; inspired by mdoclintschwarze2017-06-241-1/+7
|
* Split -Wstyle into -Wstyle and the even lower -Wbase, and addschwarze2017-06-241-30/+71
| | | | | | | | | | | | | | | -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 mdoclintschwarze2017-06-171-1/+6
|
* style message about missing RCS ids; inspired by mdoclintschwarze2017-06-171-2/+44
|
Copyright © 1996 – 2023 Jason A. Donenfeld. All Rights Reverse Engineered.