summaryrefslogtreecommitdiff
path: root/doc/nvidia-settings.1.m4
diff options
context:
space:
mode:
Diffstat (limited to 'doc/nvidia-settings.1.m4')
-rw-r--r--doc/nvidia-settings.1.m4163
1 files changed, 3 insertions, 160 deletions
diff --git a/doc/nvidia-settings.1.m4 b/doc/nvidia-settings.1.m4
index c97e8af..1349ccd 100644
--- a/doc/nvidia-settings.1.m4
+++ b/doc/nvidia-settings.1.m4
@@ -1,4 +1,5 @@
changequote([[[, ]]])dnl
+define(__OPTIONS__, [[[include([[[options.1.inc]]])dnl]]])dnl
dnl Solaris man chokes on three-letter macros.
ifelse(__BUILD_OS__,SunOS,[[[define(__URL__,UR)]]],[[[define(__URL__,URL)]]])dnl
.\" Copyright (C) 2010 NVIDIA Corporation.
@@ -51,166 +52,8 @@ Then, it displays a graphical user interface (GUI) for configuring the current s
When
.B nvidia\-settings
exits, it queries the current settings from the X server and saves them to the configuration file.
-.SH OPTIONS
-.TP
-.B \-v, \-\-version
-Print the
-.B nvidia\-settings
-version and exit.
-.TP
-.B \-h, \-\-help
-Print usage information and exit.
-.TP
-.BI "\-\-config=" config
-Use the configuration file
-.I config
-rather than the default
-.I ~/.nvidia\-settings\-rc
-.TP
-.BI "\-c, \-\-ctrl\-display=" ctrl-display
-Control the specified X display.
-If this option is not given, then
-.B nvidia\-settings
-will control the display specified by
-.B \-\-display.
-If that is not given, then the
-.I $DISPLAY
-environment variable is used.
-.TP
-.B \-n, \-\-no\-config
-Do not load the configuration file.
-This mode of operation is useful if
-.B nvidia\-settings
-has difficulties starting due to problems with applying settings in the configuration file.
-.TP
-.B \-l, \-\-load\-config\-only
-Load the configuration file, send the values specified therein to the X server, and exit.
-This mode of operation is useful to place in your .xinitrc file, for example.
-.TP
-.B \-r, \-\-rewrite\-config\-file
-Write the current X server configuration to the configuration file, and exit without starting
-a graphical user interface.
-See the EXAMPLES section.
-.TP
-.BI "\-V, \-\-verbose=" verbosity
-Controls how much information is printed.
-By default, the verbosity is
-.B errors
-and only error messages are printed.
-.br
-
-.I verbosity
-can be one of the following values:
-.ti +5
-.B errors
-- Print errors.
-.ti +5
-.B warnings
-- Print errors and warnings.
-.ti +5
-.B all
-- Print errors, warnings, and other information.
-.TP
-.BI "\-a, \-\-assign=" assign
-The
-.I assign
-argument to the
-.B \-\-assign
-command line option is of the form:
-.nf
-
- {DISPLAY}/{attribute name}[{display devices}]={value}
-
-.fi
-This assigns the attribute {attribute name} to the value {value} on the X Display {DISPLAY}.
-{DISPLAY} follows the usual {host}:{display}.{screen} syntax of the DISPLAY environment variable and is optional; when it is not specified, then it is implied following the same rule as the
-.B \-\-ctrl\-display
-option.
-If the X screen is not specified, then the assignment is made to all X screens.
-Note that the '/' is only required when {DISPLAY} is present.
-.sp
-.br
-{DISPLAY} can additionally include a target specification to direct an assignment to something other than an X screen.
-A target specification is contained within brackets and consists of a target type name, a colon, and the target id.
-The target type name can be one of
-.B screen,
-.B gpu,
-.B framelock,
-.B vcs,
-.B gvi,
-or
-.B fan;
-the target id is the index into the list of targets (for that target type).
-The target specification can be used in {DISPLAY} wherever an X screen can be used, following the syntax {host}:{display}[{target_type}:{target_id}].
-See the output of
-.nf
-
- nvidia-settings --query all
-
-.fi
-for information on which target types can be used with which attributes.
-See the output of
-.nf
-
- nvidia-settings -q screens -q gpus -q framelocks -q vcs -q gvis -q fans
-
-.fi
-for lists of targets for each target type.
-.br
-.sp
-The [{display devices}] portion is also optional; if it is not specified, then the attribute is assigned to all display devices.
-.br
-.sp
-Some examples:
-.nf
-
- -a FSAA=5
- -a localhost:0.0/DigitalVibrance[CRT-0]=0
- --assign="SyncToVBlank=1"
- -a [gpu:0]/DigitalVibrance[DFP-1]=63
-
-.fi
-.TP
-.BI "\-q, \-\-query=" query
-The
-.I query
-argument to the
-.B \-\-query
-command line option is of the form:
-.nf
-
- {DISPLAY}/{attribute name}[{display devices}]
-
-.fi
-This queries the current value of the attribute {attribute name} on the X Display {DISPLAY}.
-The syntax is the same as that for the
-.B \-\-assign
-option, without
-.B ={value}.
-Specify
-.B \-q screens,
-.B \-q gpus,
-.B \-q framelocks,
-.B \-q vcs,
-.B \-q gvis,
-or
-.B \-q fans
-to query a list of X screens, GPUs, Frame Lock devices, Visual Computing Systems, SDI Input Devices, or fans, respectively, that are present on the X Display {DISPLAY}.
-Specify
-.B \-q all
-to query all attributes.
-.TP
-.B \-t, \-\-terse
-When querying attribute values with the '--query' command line option, only print the current value, rather than the more verbose description of the attribute, its valid values, and its current value.
-.TP
-.B \-d, \-\-display\-device\-string
-When printing attribute values in response to the '--query' option, if the attribute value is a display device mask, print the value as a list of display devices (e.g., "CRT-0, DFP-0"), rather than a hexadecimal bit mask (e.g., 0x00010001).
-.TP
-.B \-g, \-\-glxinfo
-Print GLX Information for the X display and exit.
-.TP
-.B \-e, \-\-describe
-Prints information about a particular attribute. Specify 'all' to list the descriptions of all attributes. Specify 'list' to list the attribute names without a descriptions.
+dnl Call gen-manpage-opts to generate this section.
+__OPTIONS__
.SH "USER GUIDE"
.SS Contents
1. Layout of the nvidia\-settings GUI