Update mandoc style sheet

This commit is contained in:
ISSOtm
2020-03-24 10:10:49 +01:00
parent 7635a2fc74
commit 713eef9ef2
4 changed files with 272 additions and 114 deletions

351
docs/mandoc.css Executable file → Normal file
View File

@@ -1,23 +1,33 @@
/* $Id: mandoc.css,v 1.22 2017/07/16 18:45:00 schwarze Exp $ */ /* $Id: mandoc.css,v 1.45 2019/03/01 10:57:18 schwarze Exp $ */
/* /*
* Standard style sheet for mandoc(1) -Thtml and man.cgi(8). * Standard style sheet for mandoc(1) -Thtml and man.cgi(8).
*
* Written by Ingo Schwarze <schwarze@openbsd.org>.
* I place this file into the public domain.
* Permission to use, copy, modify, and distribute it for any purpose
* with or without fee is hereby granted, without any conditions.
*/ */
/* Global defaults. */ /* Global defaults. */
/* This is handled in `rgbds.css` instead html { max-width: 65em; }
*
* html { max-width: 100ex; }
*/
body { font-family: Helvetica,Arial,sans-serif; } body { font-family: Helvetica,Arial,sans-serif; }
table { margin-top: 0em; table { margin-top: 0em;
margin-bottom: 0em; } margin-bottom: 0em;
td { vertical-align: top; } border-collapse: collapse; }
/* Some browsers set border-color in a browser style for tbody,
* but not for table, resulting in inconsistent border styling. */
tbody { border-color: inherit; }
tr { border-color: inherit; }
td { vertical-align: top;
padding-left: 0.2em;
padding-right: 0.2em;
border-color: inherit; }
ul, ol, dl { margin-top: 0em; ul, ol, dl { margin-top: 0em;
margin-bottom: 0em; } margin-bottom: 0em; }
li, dt { margin-top: 1em; } li, dt { margin-top: 1em; }
a.selflink { border-bottom: thin dotted; .permalink { border-bottom: thin dotted;
color: inherit; color: inherit;
font: inherit; font: inherit;
text-decoration: inherit; } text-decoration: inherit; }
@@ -44,7 +54,6 @@ table.head { width: 100%;
td.head-vol { text-align: center; } td.head-vol { text-align: center; }
td.head-rtitle { td.head-rtitle {
text-align: right; } text-align: right; }
span.Nd { }
table.foot { width: 100%; table.foot { width: 100%;
border-top: 1px dotted #808080; border-top: 1px dotted #808080;
@@ -54,147 +63,189 @@ td.foot-os { text-align: right; }
/* Sections and paragraphs. */ /* Sections and paragraphs. */
div.manual-text { .manual-text {
margin-left: 5ex; } margin-left: 3.8em; }
h1.Sh { margin-top: 2ex; .Nd { }
margin-bottom: 1ex; section.Sh { }
margin-left: -4ex; h1.Sh { margin-top: 1.2em;
margin-bottom: 0.6em;
margin-left: -3.2em;
font-size: 110%; } font-size: 110%; }
h2.Ss { margin-top: 2ex; section.Ss { }
margin-bottom: 1ex; h2.Ss { margin-top: 1.2em;
margin-left: -2ex; margin-bottom: 0.6em;
margin-left: -1.2em;
font-size: 105%; } font-size: 105%; }
div.Pp { margin: 1ex 0ex; } .Pp { margin: 0.6em 0em; }
a.Sx { } .Sx { }
a.Xr { } .Xr { }
/* Displays and lists. */ /* Displays and lists. */
div.Bd { } .Bd { }
div.D1 { margin-left: 5ex; } .Bd-indent { margin-left: 3.8em; }
ul.Bl-bullet { list-style-type: disc; .Bl-bullet { list-style-type: disc;
padding-left: 1em; } padding-left: 1em; }
li.It-bullet { } .Bl-bullet > li { }
ul.Bl-dash { list-style-type: none; .Bl-dash { list-style-type: none;
padding-left: 0em; } padding-left: 0em; }
li.It-dash:before { .Bl-dash > li:before {
content: "\2014 "; } content: "\2014 "; }
ul.Bl-item { list-style-type: none; .Bl-item { list-style-type: none;
padding-left: 0em; } padding-left: 0em; }
li.It-item { } .Bl-item > li { }
ul.Bl-compact > li { .Bl-compact > li {
margin-top: 0ex; } margin-top: 0em; }
ol.Bl-enum { padding-left: 2em; } .Bl-enum { padding-left: 2em; }
li.It-enum { } .Bl-enum > li { }
ol.Bl-compact > li { .Bl-compact > li {
margin-top: 0ex; } margin-top: 0em; }
dl.Bl-diag { } .Bl-diag { }
dt.It-diag { } .Bl-diag > dt {
dd.It-diag { margin-left: 0ex; } font-style: normal;
b.It-diag { font-style: normal; } font-weight: bold; }
dl.Bl-hang { } .Bl-diag > dd {
dt.It-hang { } margin-left: 0em; }
dd.It-hang { margin-left: 10.2ex; } .Bl-hang { }
dl.Bl-inset { } .Bl-hang > dt { }
dt.It-inset { } .Bl-hang > dd {
dd.It-inset { margin-left: 0ex; } margin-left: 5.5em; }
dl.Bl-ohang { } .Bl-inset { }
dt.It-ohang { } .Bl-inset > dt { }
dd.It-ohang { margin-left: 0ex; } .Bl-inset > dd {
dl.Bl-tag { margin-left: 10.2ex; } margin-left: 0em; }
dt.It-tag { float: left; .Bl-ohang { }
margin-top: 0ex; .Bl-ohang > dt { }
margin-left: -10.2ex; .Bl-ohang > dd {
padding-right: 2ex; margin-left: 0em; }
.Bl-tag { margin-top: 0.6em;
margin-left: 5.5em; }
.Bl-tag > dt {
float: left;
margin-top: 0em;
margin-left: -5.5em;
padding-right: 0.5em;
vertical-align: top; } vertical-align: top; }
dd.It-tag { clear: right; .Bl-tag > dd {
clear: right;
width: 100%; width: 100%;
margin-top: 0ex; margin-top: 0em;
margin-left: 0ex; margin-left: 0em;
margin-bottom: 0.6em;
vertical-align: top; vertical-align: top;
overflow: auto; } overflow: auto; }
dl.Bl-compact > dt { .Bl-compact { margin-top: 0em; }
margin-top: 0ex; } .Bl-compact > dd {
margin-bottom: 0em; }
.Bl-compact > dt {
margin-top: 0em; }
table.Bl-column { } .Bl-column { }
tr.It-column { } .Bl-column > tbody > tr { }
td.It-column { margin-top: 1em; } .Bl-column > tbody > tr > td {
table.Bl-compact > tbody > tr > td { margin-top: 1em; }
margin-top: 0ex; } .Bl-compact > tbody > tr > td {
margin-top: 0em; }
cite.Rs { font-style: normal; .Rs { font-style: normal;
font-weight: normal; } font-weight: normal; }
span.RsA { } .RsA { }
i.RsB { font-weight: normal; } .RsB { font-style: italic;
span.RsC { } font-weight: normal; }
span.RsD { } .RsC { }
i.RsI { font-weight: normal; } .RsD { }
i.RsJ { font-weight: normal; } .RsI { font-style: italic;
span.RsN { } font-weight: normal; }
span.RsO { } .RsJ { font-style: italic;
span.RsP { } font-weight: normal; }
span.RsQ { } .RsN { }
span.RsR { } .RsO { }
span.RsT { text-decoration: underline; } .RsP { }
a.RsU { } .RsQ { }
span.RsV { } .RsR { }
.RsT { text-decoration: underline; }
.RsU { }
.RsV { }
span.eqn { } .eqn { }
table.tbl { } .tbl td { vertical-align: middle; }
.HP { margin-left: 3.8em;
text-indent: -3.8em; }
/* Semantic markup for command line utilities. */ /* Semantic markup for command line utilities. */
table.Nm { } table.Nm { }
b.Nm { font-style: normal; } code.Nm { font-style: normal;
b.Fl { font-style: normal; } font-weight: bold;
b.Cm { font-style: normal; } font-family: inherit; }
var.Ar { font-style: italic; .Fl { font-style: normal;
font-weight: bold;
font-family: inherit; }
.Cm { font-style: normal;
font-weight: bold;
font-family: inherit; }
.Ar { font-style: italic;
font-weight: normal; } font-weight: normal; }
span.Op { } .Op { display: inline; }
b.Ic { font-style: normal; } .Ic { font-style: normal;
code.Ev { font-style: normal; font-weight: bold;
font-family: inherit; }
.Ev { font-style: normal;
font-weight: normal; font-weight: normal;
font-family: monospace; } font-family: monospace; }
i.Pa { font-weight: normal; } .Pa { font-style: italic;
font-weight: normal; }
/* Semantic markup for function libraries. */ /* Semantic markup for function libraries. */
span.Lb { } .Lb { }
b.In { font-style: normal; } code.In { font-style: normal;
font-weight: bold;
font-family: inherit; }
a.In { } a.In { }
b.Fd { font-style: normal; } .Fd { font-style: normal;
var.Ft { font-style: italic; font-weight: bold;
font-family: inherit; }
.Ft { font-style: italic;
font-weight: normal; } font-weight: normal; }
b.Fn { font-style: normal; } .Fn { font-style: normal;
var.Fa { font-style: italic; font-weight: bold;
font-family: inherit; }
.Fa { font-style: italic;
font-weight: normal; } font-weight: normal; }
var.Vt { font-style: italic; .Vt { font-style: italic;
font-weight: normal; } font-weight: normal; }
var.Va { font-style: italic; .Va { font-style: italic;
font-weight: normal; } font-weight: normal; }
code.Dv { font-style: normal; .Dv { font-style: normal;
font-weight: normal; font-weight: normal;
font-family: monospace; } font-family: monospace; }
code.Er { font-style: normal; .Er { font-style: normal;
font-weight: normal; font-weight: normal;
font-family: monospace; } font-family: monospace; }
/* Various semantic markup. */ /* Various semantic markup. */
span.An { } .An { }
a.Lk { } .Lk { }
a.Mt { } .Mt { }
b.Cd { font-style: normal; } .Cd { font-style: normal;
i.Ad { font-weight: normal; } font-weight: bold;
b.Ms { font-style: normal; } font-family: inherit; }
span.St { } .Ad { font-style: italic;
a.Ux { } font-weight: normal; }
.Ms { font-style: normal;
font-weight: bold; }
.St { }
.Ux { }
/* Physical markup. */ /* Physical markup. */
.Bf { display: inline; }
.No { font-style: normal; .No { font-style: normal;
font-weight: normal; } font-weight: normal; }
.Em { font-style: italic; .Em { font-style: italic;
@@ -204,3 +255,93 @@ a.Ux { }
.Li { font-style: normal; .Li { font-style: normal;
font-weight: normal; font-weight: normal;
font-family: monospace; } font-family: monospace; }
/* Tooltip support. */
h1.Sh, h2.Ss { position: relative; }
.An, .Ar, .Cd, .Cm, .Dv, .Em, .Er, .Ev, .Fa, .Fd, .Fl, .Fn, .Ft,
.Ic, code.In, .Lb, .Lk, .Ms, .Mt, .Nd, code.Nm, .Pa, .Rs,
.St, .Sx, .Sy, .Va, .Vt, .Xr {
display: inline-block;
position: relative; }
.An::before { content: "An"; }
.Ar::before { content: "Ar"; }
.Cd::before { content: "Cd"; }
.Cm::before { content: "Cm"; }
.Dv::before { content: "Dv"; }
.Em::before { content: "Em"; }
.Er::before { content: "Er"; }
.Ev::before { content: "Ev"; }
.Fa::before { content: "Fa"; }
.Fd::before { content: "Fd"; }
.Fl::before { content: "Fl"; }
.Fn::before { content: "Fn"; }
.Ft::before { content: "Ft"; }
.Ic::before { content: "Ic"; }
code.In::before { content: "In"; }
.Lb::before { content: "Lb"; }
.Lk::before { content: "Lk"; }
.Ms::before { content: "Ms"; }
.Mt::before { content: "Mt"; }
.Nd::before { content: "Nd"; }
code.Nm::before { content: "Nm"; }
.Pa::before { content: "Pa"; }
.Rs::before { content: "Rs"; }
h1.Sh::before { content: "Sh"; }
h2.Ss::before { content: "Ss"; }
.St::before { content: "St"; }
.Sx::before { content: "Sx"; }
.Sy::before { content: "Sy"; }
.Va::before { content: "Va"; }
.Vt::before { content: "Vt"; }
.Xr::before { content: "Xr"; }
.An::before, .Ar::before, .Cd::before, .Cm::before,
.Dv::before, .Em::before, .Er::before, .Ev::before,
.Fa::before, .Fd::before, .Fl::before, .Fn::before, .Ft::before,
.Ic::before, code.In::before, .Lb::before, .Lk::before,
.Ms::before, .Mt::before, .Nd::before, code.Nm::before,
.Pa::before, .Rs::before,
h1.Sh::before, h2.Ss::before, .St::before, .Sx::before, .Sy::before,
.Va::before, .Vt::before, .Xr::before {
opacity: 0;
transition: .15s ease opacity;
pointer-events: none;
position: absolute;
bottom: 100%;
box-shadow: 0 0 .35em #000;
padding: .15em .25em;
white-space: nowrap;
font-family: Helvetica,Arial,sans-serif;
font-style: normal;
font-weight: bold;
color: black;
background: #fff; }
.An:hover::before, .Ar:hover::before, .Cd:hover::before, .Cm:hover::before,
.Dv:hover::before, .Em:hover::before, .Er:hover::before, .Ev:hover::before,
.Fa:hover::before, .Fd:hover::before, .Fl:hover::before, .Fn:hover::before,
.Ft:hover::before, .Ic:hover::before, code.In:hover::before,
.Lb:hover::before, .Lk:hover::before, .Ms:hover::before, .Mt:hover::before,
.Nd:hover::before, code.Nm:hover::before, .Pa:hover::before,
.Rs:hover::before, h1.Sh:hover::before, h2.Ss:hover::before, .St:hover::before,
.Sx:hover::before, .Sy:hover::before, .Va:hover::before, .Vt:hover::before,
.Xr:hover::before {
opacity: 1;
pointer-events: inherit; }
/* Overrides to avoid excessive margins on small devices. */
@media (max-width: 37.5em) {
.manual-text {
margin-left: 0.5em; }
h1.Sh, h2.Ss { margin-left: 0em; }
.Bd-indent { margin-left: 2em; }
.Bl-hang > dd {
margin-left: 2em; }
.Bl-tag { margin-left: 2em; }
.Bl-tag > dt {
margin-left: -2em; }
.HP { margin-left: 2em;
text-indent: -2em; }
}

View File

@@ -13,7 +13,7 @@ body {
text-align: justify; text-align: justify;
/* Center body horizontally (requires <html> to span full width) */ /* Center body horizontally (requires <html> to span full width) */
margin: 10px auto; margin: 0 auto;
/* `mandoc.css`'s default, but it's applied to <html> there */ /* `mandoc.css`'s default, but it's applied to <html> there */
max-width: 100ex; max-width: 100ex;
} }
@@ -30,6 +30,11 @@ code, pre {
font-size: smaller; font-size: smaller;
} }
pre {
/* Avoid horizontal page scrolling on mobile */
overflow: auto;
}
/* Separate lines in tables */ /* Separate lines in tables */
table.Bl-column { table.Bl-column {
border-collapse: collapse; border-collapse: collapse;

View File

@@ -153,7 +153,9 @@ prefix, entries are listed alphabetically.
Warns when Warns when
.Ic WARN Ns No -type .Ic WARN Ns No -type
assertions fail. (See assertions fail. (See
.Xr rgbasm 5 "Aborting the assembly process" .Dq Aborting the assembly process
in
.Xr rgbasm 5
for for
.Ic ASSERT ) . .Ic ASSERT ) .
.It Fl Wbuiltin-args .It Fl Wbuiltin-args
@@ -187,24 +189,31 @@ section type are encountered.
This warning is enabled by This warning is enabled by
.Fl Wextra . .Fl Wextra .
.It Fl Wshift .It Fl Wshift
Warn when shifting triggers C undefined behavior, potentially causing unpredictable behavior. Warn when shifting right a negative value.
Shfting behavior will be changed and this warning removed before next release. Use a division by 2^N instead.
.It Fl Wshift-amount
Warn when a shift's operand is negative or greater than 32.
.It Fl Wno-truncation
Warn when an implicit truncation (for example,
.Ic db )
loses some bits.
.It Fl Wno-user .It Fl Wno-user
Warns when the Warn when the
.Ic WARN .Ic WARN
built-in is executed. (See built-in is executed. (See
.Xr rgbasm 5 "Aborting the assembly process" .Dq Aborting the assembly process
in
.Xr rgbasm 5
for for
.Ic WARN ) . .Ic WARN ) .
.El .El
.Sh EXAMPLES .Sh EXAMPLES
You can assemble a source file in two ways. You can assemble a source file in two ways.
Straightforward way:
.Pp .Pp
Straightforward way:
.Dl $ rgbasm -o bar.o foo.asm .Dl $ rgbasm -o bar.o foo.asm
.Pp .Pp
Pipes way: Pipes way:
.Pp
.Dl $ cat foo.asm | rgbasm -o bar.o - .Dl $ cat foo.asm | rgbasm -o bar.o -
.Dl $ rgbasm -o bar.o - < foo.asm .Dl $ rgbasm -o bar.o - < foo.asm
.Pp .Pp

View File

@@ -239,7 +239,8 @@ There are a number of escape sequences you can use within a string:
.Pp .Pp
A funky feature is A funky feature is
.Ql {symbol} .Ql {symbol}
within a string. within a string, called
.Dq symbol interpolation .
This will paste This will paste
.Ar symbol Ap s .Ar symbol Ap s
contents as a string. contents as a string.
@@ -254,6 +255,8 @@ ANSWER = 42
PRINTT "The answer to {TOPIC} is {ANSWER}\[rs]n" PRINTT "The answer to {TOPIC} is {ANSWER}\[rs]n"
.Ed .Ed
.Pp .Pp
Symbol interpolations can be nested, too!
.Pp
It's possible to change the way numeric symbols are converted by specifying a print type like so: It's possible to change the way numeric symbols are converted by specifying a print type like so:
.Ql {d:symbol} . .Ql {d:symbol} .
Valid print types are: Valid print types are: