=================================================================== RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/mandoc/mandoc.1,v retrieving revision 1.125 retrieving revision 1.126 diff -c -r1.125 -r1.126 *** src/usr.bin/mandoc/mandoc.1 2017/06/17 23:06:43 1.125 --- src/usr.bin/mandoc/mandoc.1 2017/06/24 14:38:27 1.126 *************** *** 1,4 **** ! .\" $OpenBSD: mandoc.1,v 1.125 2017/06/17 23:06:43 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze --- 1,4 ---- ! .\" $OpenBSD: mandoc.1,v 1.126 2017/06/24 14:38:27 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze *************** *** 15,21 **** .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ! .Dd $Mdocdate: June 17 2017 $ .Dt MANDOC 1 .Os .Sh NAME --- 15,21 ---- .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" ! .Dd $Mdocdate: June 24 2017 $ .Dt MANDOC 1 .Os .Sh NAME *************** *** 75,85 **** .Xr man 7 .Ic \&TH macro. - This can also be used to perform style checks according to the - conventions of one operating system while running on a different - operating system; see - .Sx Style messages - for details. .It Fl K Ar encoding Specify the input encoding. The supported --- 75,80 ---- *************** *** 151,164 **** The .Ar level can be .Cm style , .Cm warning , .Cm error , or ! .Cm unsupp ; .Cm all is an alias for ! .Cm style . By default, .Nm is silent. --- 146,178 ---- The .Ar level can be + .Cm base , .Cm style , .Cm warning , .Cm error , or ! .Cm unsupp . ! The ! .Cm base ! level automatically derives the operating system from the contents of the ! .Ic \&Os ! macro, from the ! .Fl Ios ! command line option, or from the ! .Xr uname 3 ! return value. ! The levels ! .Cm openbsd ! and ! .Cm netbsd ! are variants of ! .Cm base ! that bypass autodetection and request validation of base system ! conventions for a particular operating system. ! The level .Cm all is an alias for ! .Cm base . By default, .Nm is silent. *************** *** 224,230 **** .It Fl T Cm lint Parse only: produce no output. Implies ! .Fl W Cm style . .It Fl T Cm locale Encode output using the current locale. This is the default. --- 238,244 ---- .It Fl T Cm lint Parse only: produce no output. Implies ! .Fl W Cm all . .It Fl T Cm locale Encode output using the current locale. This is the default. *************** *** 596,614 **** .Pp .Bl -tag -width Ds -compact .It 0 ! No style suggestions, warnings or errors occurred, or those that ! did were ignored because they were lower than the requested .Ar level . .It 1 ! At least one style suggestion occurred, but no warning or error, and .Fl W Cm style was specified. .It 2 At least one warning occurred, but no error, and .Fl W Cm warning ! or ! .Fl W Cm style ! was specified. .It 3 At least one parsing error occurred, but no unsupported feature was encountered, and --- 610,632 ---- .Pp .Bl -tag -width Ds -compact .It 0 ! No base system convention violations, style suggestions, warnings, ! or errors occurred, or those that did were ignored because they ! were lower than the requested .Ar level . .It 1 ! At least one base system convention violation or style suggestion ! occurred, but no warning or error, and ! .Fl W Cm base ! or .Fl W Cm style was specified. .It 2 At least one warning occurred, but no error, and .Fl W Cm warning ! or a lower ! .Ar level ! was requested. .It 3 At least one parsing error occurred, but no unsupported feature was encountered, and *************** *** 636,642 **** Note that selecting .Fl T Cm lint output mode implies ! .Fl W Cm style . .Sh EXAMPLES To page manuals to the terminal: .Pp --- 654,660 ---- Note that selecting .Fl T Cm lint output mode implies ! .Fl W Cm all . .Sh EXAMPLES To page manuals to the terminal: .Pp *************** *** 669,680 **** Messages displayed by .Nm follow this format: .Pp - .D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : message : macro args - .Pp Line and column numbers start at 1. Both are omitted for messages referring to an input file as a whole. Macro names and arguments are omitted where meaningless. Fatal messages about invalid command line arguments or operating system errors, for example when memory is exhausted, may also omit the --- 687,705 ---- Messages displayed by .Nm follow this format: + .Bd -ragged -offset indent + .Nm Ns : + .Ar file : Ns Ar line : Ns Ar column : level : message : macro args + .Pq Ar os + .Ed .Pp Line and column numbers start at 1. Both are omitted for messages referring to an input file as a whole. Macro names and arguments are omitted where meaningless. + The + .Ar os + operating system specifier is omitted for messages that are relevant + for all operating systems. Fatal messages about invalid command line arguments or operating system errors, for example when memory is exhausted, may also omit the *************** *** 732,740 **** --- 757,771 ---- Please use your good judgement to decide whether any particular .Cm style suggestion really justifies a change to the input file. + .It Cm base + A convertion used in the base system of a specific operating system + is not adhered to. + These are not markup mistakes, and neither the quality of formatting + nor portability are in danger. .El .Pp Messages of the + .Cm base , .Cm style , .Cm warning , .Cm error , *************** *** 746,754 **** option or .Fl T Cm lint output mode. ! .Ss Style messages ! As indicated below, some style checks are only performed if a ! specific operating system name occurs in the arguments of the .Ic \&Os macro, of the .Fl Ios --- 777,791 ---- option or .Fl T Cm lint output mode. ! .Pp ! As indicated below, all ! .Cm base ! and some ! .Cm style ! checks are only performed if a specific operating system name occurs ! in the arguments of the ! .Fl W ! command line option, of the .Ic \&Os macro, of the .Fl Ios *************** *** 756,761 **** --- 793,799 ---- of the .Xr uname 3 function. + .Ss Conventions for base system manuals .Bl -ohang .It Sy "Mdocdate found" .Pq mdoc , Nx *************** *** 778,783 **** --- 816,832 ---- keyword substitution, but using it is conventionally expected in the .Ox base system. + .It Sy "RCS id missing" + .Pq Ox , Nx + The manual page lacks the comment line with the RCS identifier + generated by CVS + .Ic OpenBSD + or + .Ic NetBSD + keyword substitution as conventionally used in these operating systems. + .El + .Ss Style suggestions + .Bl -ohang .It Sy "legacy man(7) date format" .Pq mdoc The *************** *** 791,804 **** date format .Dq "Month dd, yyyy" instead. - .It Sy "RCS id missing" - .Pq Ox , Nx - The manual page lacks the comment line with the RCS identifier - generated by CVS - .Ic OpenBSD - or - .Ic NetBSD - keyword substitution as conventionally used in these operating systems. .It Sy "duplicate RCS id" A single manual page contains two copies of the RCS identifier for the same operating system. --- 840,845 ----