From: Michael R Sweet Date: Mon, 18 Feb 2019 15:33:49 +0000 (-0500) Subject: Documentation updates. X-Git-Tag: v2.3b8~112 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=73721e3edb270a33b96a56e4a1f6f6ae1db4ff34;p=thirdparty%2Fcups.git Documentation updates. --- diff --git a/cups/Makefile b/cups/Makefile index 38080914d3..386a665982 100644 --- a/cups/Makefile +++ b/cups/Makefile @@ -752,21 +752,21 @@ apihelp: $(RM) cupspm.xml codedoc --section "Programming" --title "Administration APIs" \ --css ../doc/cups-printable.css \ - --header api-admin.header --intro api-admin.shtml \ + --header api-admin.header --body api-admin.shtml \ adminutil.c adminutil.h getdevices.c >../doc/help/api-admin.html codedoc --section "Programming" --title "PPD API (DEPRECATED)" \ --css ../doc/cups-printable.css \ - --header api-ppd.header --intro api-ppd.shtml \ - ppd.h ppd-*.c >../doc/help/api-ppd.html + --header api-ppd.header --body api-ppd.shtml \ + ppd.h ppd-*.c raster-interstub.c >../doc/help/api-ppd.html codedoc --section "Programming" --title "Raster API" \ --css ../doc/cups-printable.css \ - --header api-raster.header --intro api-raster.shtml \ - ../cups/raster.h interpret.c raster.c \ + --header api-raster.header --body api-raster.shtml \ + ../cups/raster.h raster-stubs.c \ >../doc/help/api-raster.html codedoc --section "Programming" \ --title "Filter and Backend Programming" \ --css ../doc/cups-printable.css \ - --header api-filter.header --intro api-filter.shtml \ + --header api-filter.header --body api-filter.shtml \ backchannel.c backend.h backend.c sidechannel.c sidechannel.h \ >../doc/help/api-filter.html diff --git a/cups/api-admin.shtml b/cups/api-admin.shtml index 70d284695a..ab00c9be8a 100644 --- a/cups/api-admin.shtml +++ b/cups/api-admin.shtml @@ -11,7 +11,7 @@

The administrative APIs provide convenience functions to perform certain administrative functions with the CUPS scheduler.

-
Note: +
Note:

Administrative functions normally require administrative privileges to execute and must not be used in ordinary user applications!

diff --git a/cups/api-filter.shtml b/cups/api-filter.shtml index 0a1e429849..e7ab510146 100644 --- a/cups/api-filter.shtml +++ b/cups/api-filter.shtml @@ -868,4 +868,7 @@ void *my_data; -
Note: The sandbox profile used in CUPS 2.0 still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.
+
Note: + +

The sandbox profile used in CUPS still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.

+
diff --git a/cups/api-ppd.header b/cups/api-ppd.header index cb24cd3644..bc555e638f 100644 --- a/cups/api-ppd.header +++ b/cups/api-ppd.header @@ -1,7 +1,7 @@ Administration APIs - + @@ -18,6 +18,11 @@ H1, H2, H3, H4, H5, H6, P, TD, TH { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + KBD { font-family: monaco, courier, monospace; font-weight: bold; @@ -360,14 +365,13 @@ h1, h2, h3, h4, h5, h6 { blockquote { border: solid thin gray; box-shadow: 3px 3px 5px rgba(0,0,0,0.5); - padding: 0px 10px; + padding: 10px 10px 0px; page-break-inside: avoid; } p code, li code, p.code, pre, ul.code li { background: rgba(127,127,127,0.1); border: thin dotted gray; font-family: monospace; - font-size: 90%; hyphens: manual; -webkit-hyphens: manual; page-break-inside: avoid; @@ -390,12 +394,19 @@ span.info { font-weight: bold; white-space: nowrap; } -h3 span.info, h4 span.info { - border-top-left-radius: 10px; - border-top-right-radius: 10px; +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; float: right; + font-size: 80%; padding: 3px 6px; } +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} ul.code, ul.contents, ul.subcontents { list-style-type: none; margin: 0; @@ -503,7 +514,7 @@ h3.title {

The administrative APIs provide convenience functions to perform certain administrative functions with the CUPS scheduler.

-
Note: +
Note:

Administrative functions normally require administrative privileges to execute and must not be used in ordinary user applications!

diff --git a/doc/help/api-filter.html b/doc/help/api-filter.html index 299e5e1d2a..eddd06389b 100644 --- a/doc/help/api-filter.html +++ b/doc/help/api-filter.html @@ -1,11 +1,11 @@ - + Filter and Backend Programming - + @@ -18,6 +18,11 @@ H1, H2, H3, H4, H5, H6, P, TD, TH { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + KBD { font-family: monaco, courier, monospace; font-weight: bold; @@ -360,14 +365,13 @@ h1, h2, h3, h4, h5, h6 { blockquote { border: solid thin gray; box-shadow: 3px 3px 5px rgba(0,0,0,0.5); - padding: 0px 10px; + padding: 10px 10px 0px; page-break-inside: avoid; } p code, li code, p.code, pre, ul.code li { background: rgba(127,127,127,0.1); border: thin dotted gray; font-family: monospace; - font-size: 90%; hyphens: manual; -webkit-hyphens: manual; page-break-inside: avoid; @@ -390,12 +394,19 @@ span.info { font-weight: bold; white-space: nowrap; } -h3 span.info, h4 span.info { - border-top-left-radius: 10px; - border-top-right-radius: 10px; +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; float: right; + font-size: 80%; padding: 3px 6px; } +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} ul.code, ul.contents, ul.subcontents { list-style-type: none; margin: 0; @@ -1394,7 +1405,10 @@ void *my_data; -
Note: The sandbox profile used in CUPS 2.0 still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.
+
Note: + +

The sandbox profile used in CUPS still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.

+

Functions

 CUPS 1.2/macOS 10.5 cupsBackChannelRead

Read data from the backchannel.

diff --git a/doc/help/api-ppd.html b/doc/help/api-ppd.html index f90465553f..4ddb11ae72 100644 --- a/doc/help/api-ppd.html +++ b/doc/help/api-ppd.html @@ -1,11 +1,11 @@ - + PPD API (DEPRECATED) - + @@ -18,6 +18,11 @@ H1, H2, H3, H4, H5, H6, P, TD, TH { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + KBD { font-family: monaco, courier, monospace; font-weight: bold; @@ -360,14 +365,13 @@ h1, h2, h3, h4, h5, h6 { blockquote { border: solid thin gray; box-shadow: 3px 3px 5px rgba(0,0,0,0.5); - padding: 0px 10px; + padding: 10px 10px 0px; page-break-inside: avoid; } p code, li code, p.code, pre, ul.code li { background: rgba(127,127,127,0.1); border: thin dotted gray; font-family: monospace; - font-size: 90%; hyphens: manual; -webkit-hyphens: manual; page-break-inside: avoid; @@ -390,12 +394,19 @@ span.info { font-weight: bold; white-space: nowrap; } -h3 span.info, h4 span.info { - border-top-left-radius: 10px; - border-top-right-radius: 10px; +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; float: right; + font-size: 80%; padding: 3px 6px; } +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} ul.code, ul.contents, ul.subcontents { list-style-type: none; margin: 0; @@ -442,7 +453,7 @@ h3.title { Raster API - + @@ -18,6 +18,11 @@ H1, H2, H3, H4, H5, H6, P, TD, TH { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } +H1 { font-size: 2em; } +H2 { font-size: 1.75em; } +H3 { font-size: 1.5em; } +H4 { font-size: 1.25em; } + KBD { font-family: monaco, courier, monospace; font-weight: bold; @@ -360,14 +365,13 @@ h1, h2, h3, h4, h5, h6 { blockquote { border: solid thin gray; box-shadow: 3px 3px 5px rgba(0,0,0,0.5); - padding: 0px 10px; + padding: 10px 10px 0px; page-break-inside: avoid; } p code, li code, p.code, pre, ul.code li { background: rgba(127,127,127,0.1); border: thin dotted gray; font-family: monospace; - font-size: 90%; hyphens: manual; -webkit-hyphens: manual; page-break-inside: avoid; @@ -390,12 +394,19 @@ span.info { font-weight: bold; white-space: nowrap; } -h3 span.info, h4 span.info { - border-top-left-radius: 10px; - border-top-right-radius: 10px; +h2 span.info, h3 span.info, h4 span.info { + border-radius: 10px; float: right; + font-size: 80%; padding: 3px 6px; } +h2.title span.info, h3.title span.info, h4.title span.info { + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; +} +h2.title span.info { + padding: 4px 6px; +} ul.code, ul.contents, ul.subcontents { list-style-type: none; margin: 0; @@ -442,7 +453,7 @@ h3.title { CUPS Programming Manual - + - +