summaryrefslogtreecommitdiff
path: root/share/man/man7
AgeCommit message (Collapse)Author
2019-01-25I am retiring my old email address; replace it with my OpenBSD one.Todd C. Miller
2019-01-01Now that .nf and .fi are implemented in the roff(7) parser and formattersIngo Schwarze
rather than in the man(7) parser and formatters, document them in the roff(7) manual, where they belong, rather than in the man(7) manual. Mention that they imply an output line break, and mention which macros imply these requests.
2018-12-23Finally, stop abusing .Ss and .Sx to mark up macros, use .Ic insteadIngo Schwarze
since these are clearly commands in a domain-specific language. As a nice side effect, the resulting list allows including the synopsis for each macro in the item head, reducing some repetitive verbiage.
2018-12-23Simplify and clarify instructions for .Ql, and deprecate .Li.Ingo Schwarze
The macros .Ql, .Dl, and .Bd -literal leave no room for any valid use case for .Li whatsoever. General direction discussed with jmc@.
2018-12-23Deprecate .Lp, use .Pp instead.Ingo Schwarze
Simplicity matters, and fewer macros is simpler. OK jmc@
2018-12-16The .HP macro was deprecated by groff, and that makes senseIngo Schwarze
because it serves no real purpose and works poorly with HTML. While here, describe the section argument of .TH, clarify the syntax display of .TP, and polish some wordings.
2018-12-16minor polishing, in parts related to functional improvements in the past,Ingo Schwarze
and also adding some cross references for important escape sequences
2018-12-15Yet another round of improvements to manual font selection.Ingo Schwarze
Unify handling of \f and .ft. Support \f4 (bold+italic). Support ".ft BI" and ".ft CW" for terminal output. Support the .ft request in HTML output. Reject the bogus fonts \f(C1, \f(C2, \f(C3, and \f(CP.
2018-12-15Several improvements to escape sequence handling.Ingo Schwarze
* 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.
2018-12-12zap trailing whitespace;Jason McIntyre
2018-11-25Let cells containing nothing but \^ extend the cell above.Ingo Schwarze
Missing feature reported by Pali dot Rohar at gmail dot com.
2018-11-16punctuation and macro can go on the same line;Jason McIntyre
2018-11-16kill INDEX thoroughly, point users at portslist, sqlports, pkglocatedbMarc Espie
2018-11-05document new target genMarc Espie
2018-10-17- add an example to date(1) showing how to convert between timezonesJason McIntyre
- update the description of TZ in date(1) - mention some relevant info to avoid sending the reader to another page and, when they have to refer to another page, send them to tzset(3) rather than environ(7) - update the timezone name used in environ(7), as advised by millert ok millert
2018-10-17zap extra Pp;Jason McIntyre
2018-10-16document FETCH_PACKAGES as wellMarc Espie
2018-10-04update DESCRIPTION and COMPATIBILITY, mostly correcting statementsIngo Schwarze
from the past that are no longer true
2018-10-04Stop abusing subsections to represent the list of escape sequences;Ingo Schwarze
instead, use .Bl -tag like everywhere else. The same was already done for requests quite some time ago. Also, consistently mark up escape sequences with .Ic, just like requests.
2018-09-30Make the HISTORY sections of the "intro" manuals less confusing andIngo Schwarze
more uniform; potential for confusion noticed by aalm@; OK jmc@.
2018-08-25Rudimentary implementation of the roff(7) .char (output glyphIngo Schwarze
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?
2018-08-24Rudimentary implementation of the roff(7) .while request.Ingo Schwarze
Needed for example by groff_hdtbl(7). There are two limitations: It does not support nested .while requests yet, and each .while loop must start and end in the same scope. The roff_parseln() return codes are now more flexible and allow OR'ing options.
2018-08-23Implement the roff(7) .shift and .return requests,Ingo Schwarze
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().
2018-08-21Implement the \\$@ escape sequence (insert all macro arguments,Ingo Schwarze
quoted) in addition to the already supported \\$* (similar, but unquoted). Then use \\$@ to improve the implementation of the .als request (macro alias). Needed by groff_hdtbl(7). Gosh, it feels like the manual pages of the groff package are exercising every bloody roff(7) feature under the sun. In the manual page source code itself, not merely in the implementation of the used macro packages, that is.
2018-08-21Fix some issues found looking at groff_char(7):Ingo Schwarze
* Add two missing characters, \('Y and \('y. * The Weierstrass p is not capital, see http://unicode.org/notes/tn27/. * Add a groff-compatible ASCII transliteration for U+02DC: "~".
2018-08-19Mostly complete implementation of the 'c' (character available)Ingo Schwarze
roff conditional, except that the .char request still isn't supported and that behaviour differs from groff in many edge cases. But at least valid character names and numbers are now distinguished from invalid ones. This also fixes the bug that parsing of the 'c' conditional was incomplete, which resulted in leaking the tested character to the input parser at the beginning of the body when the condition was inverted.
2018-08-18support the highly surprising escape sequence \# (line continuationIngo Schwarze
with comment); used for example by gropdf(1)
2018-08-18Massively reduce the amount of text, cutting it down to what is neededIngo Schwarze
to understand existing man(7) code and deleting parts that would only be useful for writing new documents, which we strongly discourage: * Delete the MANUAL STRUCTURE section which merely duplicates mdoc(7). * Delete internal cross references only useful for writing new code. * Delete many instances of "included only for compatibility" as the whole language is only provided for compatibility. * Fix a few minor errors and omissions.
2018-08-18implement the GNU man-ext .SY/.YS (synopsis block) macro in man,Ingo Schwarze
used in most manual pages of the groff package
2018-08-16implement the GNU man-ext .TQ macro in man(7),Ingo Schwarze
used for example by groff_diff(7)
2018-08-16Document \*(.T.Ingo Schwarze
While here, delete the section about predefined strings. For manual pages, the concept is not important enough to be discussed in such a prominent place, and some aspects of the text were also misleading. Add a shorter version of the relevant parts to the description of the \* escape sequence instead.
2018-08-15Add /usr/include/c++ to hier.7.Frederic Cambus
OK jmc@
2018-08-10handle the non-portable GNU-style \[charNN], \[charNNN] characterIngo Schwarze
escape sequences, used for example in the groff_char(7) manual page
2018-08-10The groff man-ext macros define fonts CB, CI, and CR,Ingo Schwarze
and some groff manual pages actually use them in .ft requests. It's easy enough to handle these .ft requests in mandoc, too.
2018-08-10Implement the roff(7) .nop (no operation) request.Ingo Schwarze
Examples of manual pages (ab)using it include groff(7), chem(1), groff_mom(7), and groff_hdtbl(7).
2018-08-08Even though we strongly discourage escaping hyphens in manual pagesIngo Schwarze
in general, when introducing the *typographic* term "hyphen", actually display a real hyphen in output modes supporting it.
2018-08-08Reorder the text in the "Dashes and Hyphens" subsection to keep theIngo Schwarze
simplest and most important instructions together and at the beginning. No text change. Suggested by jmc@.
2018-08-08Clarify the confusing "(text)" annotation in the character lists.Ingo Schwarze
In some cases, it meant "render as an ASCII character in output modes that have a notion of codepoints" (e.g. UTF-8, HTML); in other cases, "render in the text font in output modes that also provide a special font for mathematical symbols" (e.g. PostScript, PDF). Also explicitly annotate the escape sequences that use a special font if available. OK bentley@
2018-08-08After years of deliberation, finally provide a clear recommendationIngo Schwarze
for hyphens and minus signs in manual pages. Since there is consensus that a typographically perfect solution is impossible, let's KISS - just write "-", don't bother with "\-", all currently relevant manual page formatters can handle "-" reasonably. OK jmc@ bentley@
2018-07-28Issue a STYLE message when normalizing the date format in .Dd/.TH.Ingo Schwarze
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.
2018-07-16byebye network.conf.templateMarc Espie
2018-07-14.El should have been zapped too;Jason McIntyre
2018-07-14zap network configuration section, it's a level of tinkering that'sMarc Espie
not really supported. add another ref to PORTS_PRIVSEP here, as it is really a good idea.
2018-07-11Remove the i386 specific mention for pcvtfonts, they are also installedFrederic Cambus
on alpha and amd64. No objection from jmc@. OK deraadt@, sthen@
2018-07-10check-problems -> pkg_check-problems;Jason McIntyre
2018-07-09out-of-date -> pkg_outdated;Jason McIntyre
2018-07-09resolve-lib -> port-resolve-lib-helper;Jason McIntyre
2018-05-17Bytes only have eight bits, not nine.Ingo Schwarze
Thus, remove the placeholder for the ninth bit. Patch from Ross L Richardson <openbsd at rlr dot id dot au>.
2018-04-10Two new low-level roff(7) features:Ingo Schwarze
* .nr optional third argument (auto-increment step size) * \n+ and \n- numerical register auto-increment and -decrement bentley@ reported on Dec 9, 2013 that lang/sbcl(1) uses these.
2018-04-05Stop documenting the non-portable .R man(7) macro. Neither groffIngo Schwarze
nor the heirloom-doctools support it. Adding it was a mistake in the first place.