summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAaron Plattner <aplattner@nvidia.com>2008-02-12 21:28:56 -0800
committerAaron Plattner <aplattner@nvidia.com>2008-02-12 21:28:56 -0800
commitfb518983907cf33ab8ee7e71ef79fe920b6b5a17 (patch)
tree16dd7342ea2734bcd6c0bafa23fae939af971f96 /doc
parent429a78a02af06685581968d1be658f1fa33c2312 (diff)
1.0-96261.0-9626
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.inc4
-rw-r--r--doc/nvidia-settings.1.m446
2 files changed, 42 insertions, 8 deletions
diff --git a/doc/Makefile.inc b/doc/Makefile.inc
index 564c2fa..253e3a6 100644
--- a/doc/Makefile.inc
+++ b/doc/Makefile.inc
@@ -26,6 +26,7 @@
#
EXTRA_DIST += \
+ Makefile.inc \
NV-CONTROL-API.txt \
FRAMELOCK.txt \
nvidia-settings-user-guide.txt \
@@ -37,3 +38,6 @@ doc/nvidia-settings.1: nvidia-settings.1.m4
$(M4) -D__HEADER__=$(AUTO_TEXT) \
-D__BUILD_OS__=$(BUILD_OS) \
$< > $@
+
+dist_list::
+ @ echo $(SRC) $(EXTRA_DIST)
diff --git a/doc/nvidia-settings.1.m4 b/doc/nvidia-settings.1.m4
index 12fbe09..ae01609 100644
--- a/doc/nvidia-settings.1.m4
+++ b/doc/nvidia-settings.1.m4
@@ -9,12 +9,14 @@ __HEADER__
\\$2 \(la \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
-.TH nvidia-settings 1 2006-03-17 "nvidia-settings 1.0"
+.TH nvidia\-settings 1 2006-03-17 "nvidia\-settings 1.0"
.SH NAME
nvidia\-settings \- configure the NVIDIA graphics driver
.SH SYNOPSIS
.BI "nvidia\-settings [" "options" "]"
.br
+.BI "nvidia\-settings [" "options" "] \-\-no\-config"
+.br
.BI "nvidia\-settings [" "options" "] \-\-load\-config\-only"
.br
.BI "nvidia\-settings [" "options" "] {\-\-query=" attr " | \-\-assign=" attr = value "} ..."
@@ -22,7 +24,9 @@ nvidia\-settings \- configure the NVIDIA graphics driver
.BI "nvidia\-settings [" "options" "] \-\-glxinfo"
.PP
Options:
-.BI "[-vh] [\-\-config=" configfile "] [\-c " ctrl-display ]
+.BI "[-vh] [\-\-config=" configfile "] [\-c " ctrl-display "]"
+.br
+.I " \fB[\-\-verbose=\fP{\fIerrors \fP|\fI warnings \fP|\fI all\fP}\fB]"
.PP
.I attr
has the form:
@@ -59,7 +63,7 @@ Print usage information and exit.
Use the configuration file
.I config
rather than the default
-.I ~/.nvidia-settings-rc
+.I ~/.nvidia\-settings\-rc
.TP
.BI "\-c, \-\-ctrl\-display=" ctrl-display
Control the specified X display.
@@ -71,10 +75,35 @@ 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
+.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
@@ -164,7 +193,7 @@ Print GLX Information for the X display and exit.
.SS Contents
1. Layout of the nvidia\-settings GUI
.br
-2. How OpenGL Interacts with nvidia-settings
+2. How OpenGL Interacts with nvidia\-settings
.br
3. Loading Settings Automatically
.br
@@ -188,7 +217,7 @@ GUI.
.PP
The category list is organized in a tree: each X screen contains the relevant subcategories beneath it.
Similarly, the Display Devices category for a screen contains all the enabled display devices beneath it.
-Besides each X screen, the other top level category is "nvidia-settings Configuration", which configures behavior of the
+Besides each X screen, the other top level category is "nvidia\-settings Configuration", which configures behavior of the
.B nvidia\-settings
application itself.
.PP
@@ -214,7 +243,7 @@ Notable exceptions are OpenGL options which are only read by OpenGL when an Open
Details about the options on each page of
.B nvidia\-settings
are available in the help window.
-.SS 2. How OpenGL Interacts with nvidia-settings
+.SS 2. How OpenGL Interacts with nvidia\-settings
.PP
When an OpenGL application starts, it downloads the current values from the X driver, and then reads the environment (see
.I APPENDIX E: OPENGL ENVIRONMENT VARIABLE SETTINGS
@@ -256,7 +285,7 @@ After you have run
once and have generated a configuration file, you can then run:
.sp
.ti +5
-nvidia-settings --load-config-only
+nvidia\-settings \-\-load\-config\-only
.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
@@ -577,7 +606,8 @@ graphical interface.
.TP
.B nvidia\-settings \-\-load\-config\-only
Loads the settings stored in
-.I ~/.nvidia-settings-rc
+.I ~/.nvidia\-settings\-rc
+and exits.
.TP
.B nvidia\-settings \-\-query FSAA
Query the value of the full-screen antialiasing setting.