Problems in nfsmount.conf.5, nvidia-settings.1, nvidia-smi.1, orbd.1
esr at thyrsus.com
esr at thyrsus.com
Mon Feb 29 11:35:27 UTC 2016
This is automatically generated email about markup problems in a man
page for which you appear to be responsible. If you are not the right
person or list, please tell me so I can correct my database.
See http://catb.org/~esr/doclifter/bugs.html for details on how and
why these patches were generated. Feel free to email me with any
questions. Note: These patches do not change the modification date of
any manual page. You may wish to do that by hand.
I apologize if this message seems spammy or impersonal. The volume of
markup bugs I am tracking is over five hundred - there is no real
alternative to generating bugmail from a database and template.
--
Eric S. Raymond
-------------- next part --------------
Problems with nvidia-smi.1:
Use of low-level troff hackery to set special indents or breaks can't
be translated. The page will have rendering faults in HTML, and
probably also under third-party man page browsers such as Xman,
Rosetta, and the KDE help browser. This patch eliminates .br, .ta, .ti,
.ce, .in, and \h in favor of requests like .RS/.RE that have
structural translations.
Presentation-level use of SS could not be structurally
translated. I changed lower-level instances to .TP.
I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package. Please forward appropriately. Also
fix the package metadata so it identifies the upstream maintainers.
--- nvidia-smi.1-unpatched 2012-07-27 16:00:11.234630225 -0400
+++ nvidia-smi.1 2012-07-27 16:00:19.158630153 -0400
@@ -5,7 +5,7 @@
.SH "SYNOPSIS"
.PP
nvidia-smi [OPTION1 [ARG1]] [OPTION2 [ARG2]] ...
-.TP 25
+.SH OPTION OVERVIEW
.B " -h, --help"
Print usage information and exit
.PP
@@ -140,74 +140,95 @@
.PP
.SH "OPTIONS"
-.SS
-GENERAL OPTIONS
-.SS "\-h, \-\-help"
+.SS "GENERAL OPTIONS"
+.TP
+\-h, \-\-help
Print usage information and exit.
-.SS
-SUMMARY OPTIONS
-.SS "\-L, \-\-list\-gpus"
+.SS "SUMMARY OPTIONS"
+.TP
+\-L, \-\-list\-gpus
List each of the NVIDIA GPUs in the system, along with their serial numbers or UUIDs. Tesla and Quadro GPUs from the Fermi and Kepler family report serial numbers, which match the ids physically printed on each board. GT200 Tesla products only support UUIDs, which are also unique but do not correspond to any identifier on the board. All other products report N/A.
-.SS
-QUERY OPTIONS
-.SS "\-q, \-\-query"
+.SS QUERY OPTIONS
+.TP
+\-q, \-\-query
Display GPU or Unit info. Displayed info includes all data listed in the (\fIGPU ATTRIBUTES\fR) or (\fIUNIT ATTRIBUTES\fR) sections of this document. Some devices and/or environments don\(aqt support all possible information. Any unsupported data is indicated by a "N/A" in the output. By default information for all available GPUs or Units is displayed. Use the \fB\-i\fR option to restrict the output to a single GPU or Unit.
-.SS
+.PP
[plus optional]
-.SS "\-u, \-\-unit"
+.PP
+.TP
+\-u, \-\-unit
Display Unit data instead of GPU data. Unit data is only available for NVIDIA S\-class Tesla enclosures.
-.SS "\-i, \-\-id=ID"
+.TP
+\-i, \-\-id=ID
Display data for a single specified GPU or Unit. The specified id may be the GPU/Unit\(aqs 0\-based index in the natural enumeration returned by the driver, the GPU\(aqs board serial number, the GPU\(aqs UUID, or the GPU\(aqs PCI bus ID (as domain:bus:device.function in hex). It is recommended that users desiring consistency use either UUID or PCI bus ID, since device enumeration ordering is not guaranteed to be consistent between reboots and board serial number might be shared between multiple GPUs on the same board.
-.SS "\-f FILE, \-\-filename=FILE"
+.TP
+\-f FILE, \-\-filename=FILE
Redirect query output to the specified file in place of the default stdout. The specified file will be overwritten.
-.SS "\-x, \-\-xml\-format"
+.TP
+\-x, \-\-xml\-format
Produce XML output in place of the default human\-readable format. Both GPU and Unit query outputs conform to corresponding DTDs.
These are available via the \fB\-\-dtd\fR flag.
-.SS "\-\-dtd"
+.TP
+\-\-dtd
Use with \fB\-x\fR. Embed the DTD in the XML output.
-.SS "\-d, \-\-display"
+.TP
+\-d, \-\-display
Display only selected information: MEMORY, UTILIZATION, ECC, TEMPERATURE, POWER, CLOCK, COMPUTE, PIDS, PERFORMANCE. Flags can be combined with comma e.g. "MEMORY,ECC". Doesn\(aqt work with -u/--unit or -x/--xml-format flags.
-.SS "\-l SEC, \-\-loop=SEC"
+.TP
+\-l SEC, \-\-loop=SEC
Continuously report query data at the specified interval, rather than the default of just once. The application will sleep in\-between queries. Note that on Linux ECC error or XID error events will print out during the sleep period if the \fI-x\fR flag was not specified. Pressing Ctrl+C at any time will abort the loop, which will otherwise run indefinitely. If no argument is specified for the \fB\-l\fR form a default interval of 5 seconds is used.
-.SS
-QUERY OPTIONS
-.SS
+
+.SS QUERY OPTIONS
[any one of]
-.SS "\-pm, \-\-persistence\-mode=MODE"
+.TP
+\-pm, \-\-persistence\-mode=MODE
Set the persistence mode for the target GPUs. See the (\fIGPU ATTRIBUTES\fR) section for a description of persistence mode. Requires root. Will impact all GPUs unless a single GPU is specified using the \fI\-i\fR argument. The effect of this operation is immediate. However, it does not persist across reboots. After each reboot persistence mode will default to "Disabled".
Available on Linux only.
-.SS "\-e, \-\-ecc\-config=CONFIG"
+.TP
+\-e, \-\-ecc\-config=CONFIG
Set the ECC mode for the target GPUs. See the (\fIGPU ATTRIBUTES\fR) section for a description of ECC mode. Requires root. Will impact all GPUs unless a single GPU is specified using the \fI\-i\fR argument. This setting takes effect after the next reboot and is persistent.
-.SS "\-p, \-\-reset\-ecc\-errors=TYPE"
+.TP
+\-p, \-\-reset\-ecc\-errors=TYPE
Reset the ECC error counters for the target GPUs. See the (\fIGPU ATTRIBUTES\fR) section for a description of ECC error counter types. Available arguments are 0|VOLATILE or 1|AGGREGATE. Requires root. Will impact all GPUs unless a single GPU is specified using the \fI\-i\fR argument. The effect of this operation is immediate.
-.SS "\-c, \-\-compute\-mode=MODE"
+.TP
+\-c, \-\-compute\-mode=MODE
Set the compute mode for the target GPUs. See the (\fIGPU ATTRIBUTES\fR) section for a description of compute mode. Requires root. Will impact all GPUs unless a single GPU is specified using the \fI\-i\fR argument. The effect of this operation is immediate. However, it does not persist across reboots. After each reboot compute mode will reset to "DEFAULT".
-.SS "\-dm, \-\-driver\-model"
-.SS "\-fdm, \-\-force\-driver\-model"
+.TP
+\-dm, \-\-driver\-model, \-fdm, \-\-force\-driver\-model
Enable or disable TCC driver model. For Windows only. Requires administrator privileges. \fI\-dm\fR will fail if a display is attached, but \fI\-fdm\fR will force the driver model to change. Will impact all GPUs unless a single GPU is specified using the \fI\-i\fR argument. A reboot is required for the change to take place. See \fBDriver Model\fR for more information on Windows driver models.
-.SS "\-r, \-\-gpu\-reset"
+.TP
+\-r, \-\-gpu\-reset
Resets GPU state by performing a secondary bus reset. Can be used to clear double bit ECC errors or recover hung GPU. Requires -i switch to target specific device. Requires root. There can\(aqt be any applications using this particular device (e.g. CUDA application, graphics application like X server, monitoring application like other instance of nvidia-smi). There also can\(aqt be any compute applications running on any other GPU in the system. Only on supported devices from Fermi and Kepler family running on Linux.
-.SS
+.PP
[plus optional]
-.SS "\-i, \-\-id=ID"
+.PP
+.TP
+\-i, \-\-id=ID
Modify a single specified GPU. The specified id may be the GPU/Unit\(aqs 0\-based index in the natural enumeration returned by the driver, the GPU\(aqs board serial number, the GPU\(aqs UUID, or the GPU\(aqs PCI bus ID (as domain:bus:device.function in hex). It is recommended that users desiring consistency use either UUID or PCI bus ID, since device enumeration ordering is not guaranteed to be consistent between reboots and board serial number might be shared between multiple GPUs on the same board.
-.SS
-UNIT MODIFICATION OPTIONS
-.SS "\-t, \-\-toggle\-led=STATE"
+.PP
+.SS UNIT MODIFICATION OPTIONS
+.TP
+\-t, \-\-toggle\-led=STATE
Set the LED indicator state on the front and back of the unit to the specified color. See the (\fIUNIT ATTRIBUTES\fR) section for a description of the LED states. Allowed colors are 0|GREEN and 1|AMBER. Requires root.
-.SS
+.PP
[plus optional]
-.SS "\-i, \-\-id=ID"
+.PP
+.TP
+\-i, \-\-id=ID
Modify a single specified Unit. The specified id is the Unit\(aqs 0-based index in the natural enumeration returned by the driver.
-.SS
-SHOW DTD OPTIONS
-.SS "\-\-dtd"
+.PP
+.SS SHOW DTD OPTIONS
+.TP
+\-\-dtd
Display Device or Unit DTD.
-.SS
+.PP
[plus optional]
-.SS "\-f FILE, \-\-filename=FILE"
+.PP
+.TP
+\-f FILE, \-\-filename=FILE
Redirect query output to the specified file in place of the default stdout. The specified file will be overwritten.
-.SS "\-u, \-\-unit"
+.TP
+\-u, \-\-unit
Display Unit DTD instead of device DTD.
.PP
.SH "GPU ATTRIBUTES"
-------------- next part --------------
Problems with nfsmount.conf.5:
Broken command synopsis syntax. This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but most cases of it
are impossible to translate into DocBook markup), or it may mean the
command syntax fails to match the description.
I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package. Please forward appropriately. Also
fix the package metadata so it identifies the upstream maintainers.
--- nfsmount.conf.5-unpatched 2014-06-02 10:36:33.179517783 -0400
+++ nfsmount.conf.5 2014-06-02 10:36:32.899511243 -0400
@@ -2,10 +2,10 @@
.TH NFSMOUNT.CONF 5 "9 October 2012"
.SH NAME
nfsmount.conf - Configuration file for NFS mounts
-.SH SYNOPSIS
+.SH DESCRIPTION
Configuration file for NFS mounts that allows options
to be set globally, per server or per mount point.
-.SH DESCRIPTION
+.PP
The configuration file is made up of multiple sections
followed by variables associated with that section.
A section is defined by a string enclosed by
-------------- next part --------------
Problems with nvidia-settings.1:
Use of low-level troff hackery to set special indents or breaks can't
be translated. The page will have rendering faults in HTML, and
probably also under third-party man page browsers such as Xman,
Rosetta, and the KDE help browser. This patch eliminates .br, .ta, .ti,
.ce, .in, and \h in favor of requests like .RS/.RE that have
structural translations.
Syntax had to be rearranged because of an options callout.
This is still excessively complicated; third-party man-page
viewers are likely to choke on it.
I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package. Please forward appropriately. Also
fix the package metadata so it identifies the upstream maintainers.
--- nvidia-settings.1-unpatched 2012-07-27 15:44:36.930647733 -0400
+++ nvidia-settings.1 2012-07-27 15:44:58.562647424 -0400
@@ -10,6 +10,17 @@
.SH NAME
nvidia\-settings \- configure the NVIDIA graphics driver
.SH SYNOPSIS
+Options:
+.br
+.B nvidia\-settings
+.BI "[-vh] [\-\-config=" configfile "] [\-c " ctrl-display "]"
+.br
+.I " \fB[\-\-verbose=\fP{\fIerrors \fP|\fI warnings \fP|\fI all\fP}\fB]"
+.br
+.I " \fB[\-\-describe=\fP{\fIall \fP|\fI list \fP|\fI attribute_name\fP}\fB]"
+.PP
+Invocation modes:
+.br
.BI "nvidia\-settings [" "options" "]"
.br
.BI "nvidia\-settings [" "options" "] \-\-no\-config"
@@ -20,17 +31,11 @@
.br
.BI "nvidia\-settings [" "options" "] \-\-glxinfo"
.PP
-Options:
-.BI "[-vh] [\-\-config=" configfile "] [\-c " ctrl-display "]"
-.br
-.I " \fB[\-\-verbose=\fP{\fIerrors \fP|\fI warnings \fP|\fI all\fP}\fB]"
-.br
-.I " \fB[\-\-describe=\fP{\fIall \fP|\fI list \fP|\fI attribute_name\fP}\fB]"
-.PP
.I attr
has the form:
-.ti +5
+.RS
.IB DISPLAY / attribute_name [ display_devices ]
+.RE
.SH DESCRIPTION
The
.B nvidia\-settings
@@ -277,8 +282,9 @@
.B nvidia\-settings
once and have generated a configuration file, you can then run:
.sp
-.ti +5
+.RS
nvidia\-settings \-\-load\-config\-only
+.RE
.sp
at any time in the future to upload these settings to the X server again.
For example, you might place the above command in your
@@ -545,8 +551,9 @@
man pages, or refer to your system documentation on remote X applications and security.
You might also Google for terms such as "remote X security" or "remote X Windows", and see documents such as the Remote X Apps mini-HOWTO:
.sp
-.ti +5
+.RS
.URL http://www.tldp.org/HOWTO/Remote-X-Apps.html
+.RE
.sp
Please also note that the remote X server to be controlled must be using the NVIDIA X driver.
.SS 7. Licensing
@@ -555,8 +562,9 @@
is released as GPL.
The most recent official version of the source code is available here:
.sp
-.ti +5
+.RS
.URL ftp://download.nvidia.com/XFree86/nvidia-settings/
+.RE
.sp
Note that
.B nvidia\-settings
-------------- next part --------------
Problems with orbd.1:
Missing or garbled name section. The most common form of garbling
is a missing - or extra -. Or your manual page may have been generated
by a tool that doesn't emit a NAME section as it should. Or your page
may add running text such as a version or authorship banner. These
problems make it impossible to lift the page to DocBook. They
can also confuse third-party manpage browsers and some implementations
of man -k.
This page was generated from some sort of non-man markup. Please
fix the upstream markup so that it generates a well-formed
manual page with the indicated corrections.
I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package. Please forward appropriately. Also
fix the package metadata so it identifies the upstream maintainers.
--- orbd.1-unpatched 2013-05-24 04:20:13.334685422 -0400
+++ orbd.1 2013-05-24 04:20:37.514684969 -0400
@@ -24,17 +24,6 @@
.LP
.SH "Name"
orbd \- The Object Request Broker Daemon
-.LP
-.LP
-\f3orbd\fP is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment.
-.LP
-.LP
-\f3See also:\fP
-.na
-\f2Naming Service\fP @
-.fi
-http://docs.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html
-.LP
.SH "SYNOPSIS"
.LP
.nf
@@ -48,6 +37,13 @@
.LP
.SH "DESCRIPTION"
.LP
+\f3orbd\fP is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment.
+.LP
+\f3See also:\fP
+.na
+\f2Naming Service\fP @
+.fi
+http://docs.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html
.LP
The Server Manager included with the \f3orbd\fP tool is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. The persistent servers, while publishing the persistent object references in the Naming Service, include the port number of the ORBD in the object reference instead of the port number of the Server. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages:
.LP
More information about the Ubuntu-devel-discuss
mailing list