openbsd-src/usr.bin/mandoc/ at jcs · jcs.org/openbsd-src

jcs.org / openbsd-src

jcs's openbsd hax

openbsd

openbsd-src / usr.bin / mandoc /

at jcs 101 files

Repair "make man.cgi" which got accidentally broken in the previous commit to the Makefile. The man.cgi binary now uses roff_escape.o, too.

3 years ago

add a missing .Pp

5 years ago

Retire OpenBSD/sgi.

5 years ago

mdoc(7): improve output of .At 32v

4 years ago

spelling fixes; from paul tagliamonte amendments to his diff are noted on tech

3 years ago

Simplify: write HTTP 303 redirects with relative locations. Suggested by bentley@.

9 years ago

In groff commit 78e66624 on May 7 20:15:33 2021 +1000, G. Branden Robinson changed the -T ascii rendering of \(sd, the "second" symbol, U+2033 DOUBLE PRIME, from '' to ". Follow suit in mandoc.

3 years ago

When sorting page names (without section numbers) in the mandoc database, after sorting by name type in descending order (to put the most important names first), use the same sort order that is conventional in SEE ALSO sections: first case-insensitively in ascending alphabetic order, and if that results in a tie because two names differ only in case (like OSSL_TRACE_END and OSSL_trace_end, which are *different* names that, in FreeBSD, are documented in the same manual page - why am i unsurprised that such madness occurs with "OSSL" of all APIs?), break the tie by sorting case-sensitively in ascending alphabetic order, i.e. put capitals before lowercase letters, rather than allowing the tie to result in a random order.

6 months ago

When the content of a manual page does not specify a section, the empty string got added to the list of sections, breaking the database format slightly and causing the page to not be considered part of any section, not even if a section could be deduced from the directory or from the file name. Bug found due to the bogus pcredemo(3) "manual" in the pcre-8.38p0 package.

9 years ago

Remove the dependency on SQLite without loss of functionality. Drop the obsolete names_check() now that we deleted MLINKS. Run "doas makewhatis" after compiling and installing this.

9 years ago

Remove the dependency on SQLite without loss of functionality. Drop the obsolete names_check() now that we deleted MLINKS. Run "doas makewhatis" after compiling and installing this.

9 years ago

spelling fixes; from paul tagliamonte amendments to his diff are noted on tech

3 years ago

Remove the dependency on SQLite without loss of functionality. Drop the obsolete names_check() now that we deleted MLINKS. Run "doas makewhatis" after compiling and installing this.

9 years ago

Remove the dependency on SQLite without loss of functionality. Drop the obsolete names_check() now that we deleted MLINKS. Run "doas makewhatis" after compiling and installing this.

9 years ago

delete trailing whitespace and space-tab sequences; no code change; patch from Michal Nowak <mnowak at startmail dot com> who found these with git pbchk in the illumos tree

6 years ago

Remove the dependency on SQLite without loss of functionality. Drop the obsolete names_check() now that we deleted MLINKS. Run "doas makewhatis" after compiling and installing this.

9 years ago

Improve clarity of some casts; from Christos Zoulas <christos at NetBSD>.

9 years ago

delete trailing whitespace and space-tab sequences; no code change; patch from Michal Nowak <mnowak at startmail dot com> who found these with git pbchk in the illumos tree

6 years ago

spelling fixes; from paul tagliamonte amendments to his diff are noted on tech

3 years ago

Cleanup, no functional change: No need to expose the eqn(7) syntax tree data structures everywhere. Move them to their own include file, "eqn.h". While here, delete the unused enum eqn_pilet.

7 years ago

The header file "html.h" uses enum roff_tok, so "roff.h" must be included before it. Diff from bcallah@ tweaked by me; he found the bug by compiling with pcc.

7 years ago

To prevent infinite recursion while expanding eqn(7) definitions, we must not reset the recursion counter when moving beyond the end of the *previous* expansion, but we may only do so when moving beyond the rightmost position reached by *any* expansion in the current equation. This matters because definitions can nest; consider:

4 years ago

Cleanup, no functional change: No need to expose the eqn(7) syntax tree data structures everywhere. Move them to their own include file, "eqn.h". While here, delete the unused enum eqn_pilet.

7 years ago

prevent breakable hyphens in segment identifiers from being turned into underscores; bug reported by <Eldred dot fr> Habert

3 years ago

While the HTML standard allows multiple <h1> elements in the same document, <h1> is intended for top level headers, and most of the sections in a manual page can hardly be considered top-level. It is more usual to use <h1> only for the main title of the document of for the site name.

3 years ago

Cleanup, no functional change: Since the man(7) and roff(7) validators no longer use the parser state flag ROFF_NOFILL, we can finally get rid of the function man_state(), resulting in a better separation of parsing and validation.

7 years ago

Add an additional argument to the functions implementing the roff(7) numerical parser to select the default scaling unit for numbers not followed by a scaling unit, rather than always using basic units ('u').

1 year ago

remove prototypes with no matching function and externs with no var partly checked by millert@

2 years ago

Fix a bug where formatting two compressed manual pages in row failed to decompress the second one. The problem was calling mparse*() functions in the wrong order mparse_open -> mparse_reset -> mparse_readfd instead of in the correct order mparse_reset -> mparse_open -> mparse_readfd: mparse_reset() clears the gzip flag, mparse_open() sets it if the new file is gzipped, and read_whole_file() called from mparse_readfd() enables decompression if the flag is set. To make the code easier to follow, call all of mparse_alloc(), mparse_reset(), and mparse_free() from main() rather than hiding mparse_reset() two levels down in the parse() subroutine.

6 months ago

Reset HTML formatter state, in particular the id_unique hash, after processing each manual page, such that the next page starts from a clean state and doesn't continue suffix numbering.

7 years ago

Just say that the databases are intended for use by apropos(1), whatis(1), and man(1), without restricting that statement to "man -k". Suggested by and patch OK'ed by jmc@.

4 years ago

In the opening paragraph, mention search expressions and jumping to terms because those are the two most important features that set our man(1) apart from older implementations. Also, add one example for each of them to the EXAMPLES section.

1 year ago

Warn about blank lines in man(7) just like it is already done in mdoc(7). Feature suggested by Alejandro Colomar <alx@kernel.org> on <groff@gnu.org>.

7 months ago

improve the description of header.html and footer.html

3 years ago

Finally delete support for the "_whatdb" configuration directive, which has a misleading syntax. It was declared obsolete and superseded by the "manpath" directive five years ago.

6 years ago

The upcoming .while request will have to re-execute roff(7) lines parsed earlier, so they will have to be saved for reuse - but the read.c preparser does not know yet whether a line contains a .while request before passing it to the roff parser. To cope with that, save all parsed lines for now. Even shortens the code by 20 lines.

7 years ago

Change the footer line to always show NAME(SECTION) on the right hand side.

9 months ago

Reduce the man(7) default global indentation from 7n, which was an oddity in groff-1.01 to groff-1.22.4, to 5n for compatibility with Version 7 AT&T UNIX, 4.3BSD-Reno, groff-1.23.0, and all versions of mdoc(7). OK jmc@ millert@

2 years ago

Fix a bug in .ll handling: When formatting two input files in a row, a line length set with .ll in the first file leaked to the second file. Also, mandoc used the changed line length for the page footer, whereas groff resets .ll before the page footer.

3 months ago

If the first argument of the .TH macro (the manual page name) is an empty string (as in: .TH "" ...), which is invalid syntax, use the fixed string "UNTITLED" instead, in the same was as in mdoc(7). This is needed because if *both* the first and the second arguments are empty strings (as in: .TH "" "" ...), makewhatis(8) assumes the file is not a valid man(7) file at all and marks it as preformatted (FORM_CAT) in mandoc.db(5) such that man(1) displays it verbatim, without formatting it.

9 months ago

undocumented options -O outfilename and -O tagfilename to support regression testing without a tty; no user visible change intended

5 years ago

Warn about blank lines in man(7) just like it is already done in mdoc(7). Feature suggested by Alejandro Colomar <alx@kernel.org> on <groff@gnu.org>.

7 months ago

Make roff_expand() parse left-to-right rather than right-to-left. Some escape sequences have side effects on global state, implying that the order of evaluation matters. For example, this fixes the long-standing bug that "\n+x\n+x\n+x" after ".nr x 0 1" used to print "321"; now it correctly prints "123".

3 years ago

Change the footer line to always show NAME(SECTION) on the right hand side.

9 months ago

In the tbl(7) layout parser, use the roff(7) numerical expression parser to support arithmetic operations in column width modifiers.

1 year ago

Fix the mandoc_strndup() utility function. All existing callers seem safe so far, but implementing it with an unchecked memcpy(3) is just wrong and quite dangerous.

8 years ago

Implement automatic line breaking inside individual table cells that contain text blocks. This cures overlong lines in various Xenocara manuals.

8 years ago

In the tbl(7) layout parser, use the roff(7) numerical expression parser to support arithmetic operations in column width modifiers.

1 year ago

including <ohash.h> requires including <stdint.h> beforehand; noticed by Svyatoslav Mishyn <juef at openmailbox dot org>

10 years ago

In private header files, __BEGIN_DECLS and __END_DECLS are pointless. Because these work slightly differently on different systems, they are becoming a maintenance burden in the portable version, so delete them.

10 years ago

In the past, generating comment nodes stopped at the .TH or .Dd macro, which is usually close to the beginning of the file, right after the Copyright header comments. But espie@ found horrible input files in the textproc/fstrcmp port that generate lots of parse nodes before even getting to the header macro. In some formatters, comment nodes after some kinds of real content triggered assertions.

6 years ago

If a single page references the same non-existent manual more than once, print "(N times)" after the message "referenced manual not found", to lessen the risk that people fix the first instance and miss the others; jmc@ confirmed that this is useful.

8 years ago

If a single page references the same non-existent manual more than once, print "(N times)" after the message "referenced manual not found", to lessen the risk that people fix the first instance and miss the others; jmc@ confirmed that this is useful.

8 years ago

In the SYNOPSIS, support the input syntax ".Lb libname [...]" with multiple arguments, to be printed as "/* -lname [...] */" and to be searched for with the already established syntax "man -k Lb=libname". Nothing changes outside the SYNOPSIS section.

10 months ago

Finally delete the ugly -O mdoc option.

9 months ago

spelling fixes; from paul tagliamonte amendments to his diff are noted on tech

3 years ago

In man(1) mode, i.e. when asking for a single manual page by name, prefer file name matches over .Dt/.TH matches over first NAME matches over later NAME matches, but do not change the ordering for apropos(1) nor for man -a.

7 years ago

Support manual tagging of .Pp, .Bd, .D1, .Dl, .Bl, and .It. In HTML output, improve the logic for writing inside permalinks: skip them when there is no child content or when there is a risk that the children might contain flow content.

6 years ago

Cleanup, no functional change:

7 years ago

When parsing a tab character that is not preceded by a space character on an .It -column line, args() sets the MDOC_PHRASEQL flag to Quote the Last word of the Phrase. Even if it turns out this quoting is not needed because the word is already quoted for other reasons, clear the flag at the end of parsing the phrase, such that the flag does not leak to the next phrase.

6 years ago

Change the footer line to always show NAME(SECTION) on the right hand side.

9 months ago

Use the MDOC_JOIN feature for .Ft, too. Semantically, this makes sense because printing two function return types one right after the other with nothing in between is never useful, whereas function return types consisting of more than one word are widespread. The change matters because people usually do not quote multi-word function return types (nor should they). We have about 1800 unquoted instances in our tree versus about 300 quoted instances.

9 months ago

Putting .PP in front of .RS results in unreliable and surprising semantics. For example, with groff-1.23, the sequence text .PD 0 .PP .PD .RS .PP text does not result in a blank line between the two text lines. Consequently, avoid .PP in front of .RS in general.

9 months ago

mdoc_markdown.c

Change the footer line to always show NAME(SECTION) on the right hand side.

9 months ago

Up to version 1.22.4, groff_mdoc(7) only considered the first word when comparing section headers. For example, ".Sh SEE ELSEWHERE" and ".Sh SEE Em ALSO" were considered instances of a SEE ALSO section. In groff-current, exact matches with no sub-macros are required. Adjust mandoc behaviour.

3 years ago

Fix a bug in .ll handling: When formatting two input files in a row, a line length set with .ll in the first file leaked to the second file. Also, mandoc used the changed line length for the page footer, whereas groff resets .ll before the page footer.

3 months ago

mdoc_validate.c

If the second argument to .Dt (the section number) is invalid, print "LOCAL" for the volume title, just like when the section number is missing. This improves compatibility with groff-1.23.0, and it's not a big deal because we don't use invalid section numbers in our manuals.

8 months ago

Major cleanup; may imply minor changes in edge cases of error reporting.

7 years ago

delete old, undocumented, obsolete section names that nobody uses

8 years ago

In 2009, kristaps@ decided that using EN as the basic unit for horizontal widths on terminal output devices was the simplest option. It made sense because one EN is the smallest possible horizontal cursor movement on a terminal. In 2014, kristaps@ implemented the 'u' unit (BU, "basic unit") for scaled width input as 1/24 EN, but all internal variables continued to store widths in units of EN.

8 months ago

In 2009, kristaps@ decided that using EN as the basic unit for horizontal widths on terminal output devices was the simplest option. It made sense because one EN is the smallest possible horizontal cursor movement on a terminal. In 2014, kristaps@ implemented the 'u' unit (BU, "basic unit") for scaled width input as 1/24 EN, but all internal variables continued to store widths in units of EN.

8 months ago

Cleanup, no functional change: Split the top level parser interface out of the utility header mandoc.h, into a new header mandoc_parse.h, for use in the main program and in the main parser only. Move enum mandoc_os into roff.h because struct roff_man is the place where it is stored. This allows removal of mandoc.h from seven files in low-level parsers and in formatters.

7 years ago

Add some missing OpenBSD RCS markers and a few missing <sys/types.h> inclusions; no code change.

11 years ago

improve a comment explaining a particularly nasty hack; no code change

3 years ago

For release, fix a regression test that failed on i386 in the simplest possible and least intrusive way. The existing code miscalculated the scaled length 100M as 23u instead of the correct result 24u, but only when compiled with -O2 on i386. The problem was reported by bluhm@.

1 year ago

Implement the man(7) .MR macro, a 2023 GNU extension. The syntax and semantics is almost identical to mdoc(7) .Xr.

2 years ago

Fix UTF-16 surrogate detection: lower case variants have to be rejected, too.

2 years ago

In HTML output, allow switching the desired font for subsequent text without printing an opening tag right away, and use that in the .ft request handler. While here, garbage collect redundant enum htmlfont and reduce code duplication in print_text(). Fixing an assertion failure reported by Michael <Stapelberg at Debian> in pmRegisterDerived(3) from libpcp3-dev.

7 years ago

Avoid the layering violation of re-parsing for \E in roff_expand(). To that end, add another argument to roff_escape() returning the index of the escape name. This also makes the code in roff_escape() a bit more uniform in so far as it no longer needs the "char esc_name" local variable but now does everything with indices into buf[]. No functional change.

3 years ago

Avoid implicitly converting a potentially negative page offset to size_t and then back to int. While this was not a bug and the end result was portably correct, Alexander Ziaee@ privately reported to me that the GCC 14 in the FreeBSD Jenkins CI felt uneasy about it.

7 months ago

roff_validate.c

Introduce the concept of nodes that are semantically transparent: they are skipped when looking for previous or following high-level macros. Examples include roff(7) .ft, .ll, and .ta, mdoc(7) .Sm and .Tg, and man(7) .DT and .PD. Use this concept for a variety of improved decisions in various validators and formatters.

6 years ago

Add an .St argument for C23.

1 year ago

1. Do not put ASCII_HYPH (0x1c) into the tag file. That happened when tagging a string containing '-' on an input text line, most commonly in man(7) .TP next line scope. 2. Do not let "\-" end the tag. In both cases, translate ASCII_HYPH and "\-" to plain '-' for output. For example, this improves handling of unbound.conf(5).

2 years ago

When a .Tg is attached to a paragraph, attach the permalink to the first word, or the first few words if they are short.

6 years ago

In the tbl(7) layout parser, use the roff(7) numerical expression parser to support arithmetic operations in column width modifiers.

1 year ago

In 2009, kristaps@ decided that using EN as the basic unit for horizontal widths on terminal output devices was the simplest option. It made sense because one EN is the smallest possible horizontal cursor movement on a terminal. In 2014, kristaps@ implemented the 'u' unit (BU, "basic unit") for scaled width input as 1/24 EN, but all internal variables continued to store widths in units of EN.

8 months ago

Quirk-compatibility with GNU tbl(1): With the "nospaces" option, skip space characters before and after "T{", in addition to skipping those at the beginning and end of data cells.

4 years ago

In 2009, kristaps@ decided that using EN as the basic unit for horizontal widths on terminal output devices was the simplest option. It made sense because one EN is the smallest possible horizontal cursor movement on a terminal. In 2014, kristaps@ implemented the 'u' unit (BU, "basic unit") for scaled width input as 1/24 EN, but all internal variables continued to store widths in units of EN.

8 months ago

remove prototypes with no matching function and externs with no var partly checked by millert@

2 years ago

In 2009, kristaps@ decided that using EN as the basic unit for horizontal widths on terminal output devices was the simplest option. It made sense because one EN is the smallest possible horizontal cursor movement on a terminal. In 2014, kristaps@ implemented the 'u' unit (BU, "basic unit") for scaled width input as 1/24 EN, but all internal variables continued to store widths in units of EN.

8 months ago

Almost mechanical diff to remove the "struct mparse *" argument from mandoc_msg(), where it is no longer used. While here, rename mandoc_vmsg() to mandoc_msg() and retire the old version: There is really no point in having another function merely to save "%s" in a few places. Minus 140 lines of code.

7 years ago

Cleanup, no functional change: Now that message handling is properly encapsulated, remove struct mparse pointers from four structs (roff, roff_man, tbl_node, eqn_node) and from the argument lists of five functions (roff_alloc, roff_man_alloc, mandoc_getarg, tbl_alloc, eqn_alloc). Except for being passed to the main program as an opaque object, it now only occurs in read.c, as it should, and not across 15 files like in the past.

7 years ago

Separate a vertical line on the left side of a table by horizontal whitespace of 1n from the content of the leftmost column, both when the line results from a table option (e.g. "box") and when it results from a '|' layout option.

8 months ago

Strangely, groff accepts .ll arguments with multiple signs. For odd numbers of minus signs, the intended behaviour is decreasing the line length, for even numbers, increasing it. The code in term_setwidth() resulted in incorrect behaviour in two cases: for more than two signs, the line length wasn't changed at all because a2roffsu() was called incorrectly and failed, and if the second sign was negative, a negative width was passed to the setwidth() callbacks, which they aren't prepared to handle.

3 months ago

Fix a bug in .ll handling: When formatting two input files in a row, a line length set with .ll in the first file leaked to the second file. Also, mandoc used the changed line length for the page footer, whereas groff resets .ll before the page footer.

3 months ago

Fix a bug in .ll handling: When formatting two input files in a row, a line length set with .ll in the first file leaked to the second file. Also, mandoc used the changed line length for the page footer, whereas groff resets .ll before the page footer.

3 months ago

Fix a bug in .ll handling: When formatting two input files in a row, a line length set with .ll in the first file leaked to the second file. Also, mandoc used the changed line length for the page footer, whereas groff resets .ll before the page footer.

3 months ago

In 2009, kristaps@ decided that using EN as the basic unit for horizontal widths on terminal output devices was the simplest option. It made sense because one EN is the smallest possible horizontal cursor movement on a terminal. In 2014, kristaps@ implemented the 'u' unit (BU, "basic unit") for scaled width input as 1/24 EN, but all internal variables continued to store widths in units of EN.

8 months ago

Append .html suffix to temporary files enabling browsers to recognise it

5 years ago

Append .html suffix to temporary files enabling browsers to recognise it

5 years ago

More accurately represent cells containing horizontal lines in -T tree output. In particular, do not represent "_" as "-", and distinguish "_" from "\_" and "=" from "\=". Output tweak following a related question from Ted Bullock <tbullock at comlore dot com>.

4 years ago