Initial commit
[xorg_rtime.git] / xorg-server-1.4 / hw / xfree86 / utils / xorgcfg / xorgcfg.man.pre
blob45fbb496999c5ab7398430ce38895440ce362751
1 .\"
2 .\" $XdotOrg: $
3 .\" Copyright (c) 2000 by Conectiva S.A. (http://www.conectiva.com)
4 .\"
5 .\" Permission is hereby granted, free of charge, to any person obtaining a
6 .\" copy of this software and associated documentation files (the "Software"),
7 .\" to deal in the Software without restriction, including without limitation
8 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 .\" and/or sell copies of the Software, and to permit persons to whom the
10 .\" Software is furnished to do so, subject to the following conditions:
11 .\"
12 .\" The above copyright notice and this permission notice shall be included in
13 .\" all copies or substantial portions of the Software.
14 .\"
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18 .\" CONECTIVA LINUX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
20 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 .\" SOFTWARE.
22 .\"
23 .\" Except as contained in this notice, the name of Conectiva Linux shall
24 .\" not be used in advertising or otherwise to promote the sale, use or other
25 .\" dealings in this Software without prior written authorization from
26 .\" Conectiva Linux.
27 .\"
28 .\" Author: Paulo César Pereira de Andrade <pcpa@conectiva.com.br>
29 .\"
30 .\" $XFree86: xc/programs/Xserver/hw/xfree86/xf86cfg/xf86cfg.man,v 1.9 2002/12/30 14:34:02 herrb Exp $
31 .\"
32 .TH xorgcfg __appmansuffix__ __vendorversion__
33 .SH NAME
34 xorgcfg - Graphical configuration tool for __xservername__
35 .SH SYNOPSIS
36 .B xorgcfg
37 [-config \fIconfigfile\fP] [-modulepath \fImoduledir\fP] 
38 [-fontpath \fIfontsdir\fP] [-toolkitoption ...]
39 .SH DESCRIPTION
40 .I Xorgcfg
41 is a tool to configure\fI __xservername__\fP, and can be used to either write the
42 initial configuration file or make customizations to the current configuration.
43 .PP
44 When the \fBDISPLAY\fP environment variable is not set, xorgcfg will run
45 the command\fI __xservername__ -configure\fP to allow the xserver to detect the
46 hardware in the computer, and write an initial\fI __xconfigfile__\fP file
47 in the user's home directory. Then, it will start 
48 __xservername__ and allow customizations.
49 .PP
50 If the \fBDISPLAY\fP environment variable is set, xorgcfg will read the
51 default\fI __xconfigfile__\fP, which may or may not be the one being used by 
52 the current server, and allow customizations.
53 .PP
54 To use an alternative location for modules or fonts the respective search
55 paths may be specified.
56 .PP
57 Unless there is an \fBApply\fP button in the current xorgcfg dialog, the
58 changes made will take place the next time\fI __xservername__\fP is started.
59 .PP
60 Xorgcfg allows addition and configuration of new devices, such as video cards,
61 monitors, keyboards and mouses.
62 .PP
63 Screen layout configuration for xinerama or traditional multi-head is also
64 available.
65 .PP
66 Modelines can be configured or optimized.
67 .PP
68 AccessX basic configurations can be made in the xorgcfg's accessx section.
70 .SH OPTIONS
71 .TP 8
72 .I -config
73 Specifies an alternate __xconfigfile__ file for configuration.
74 .TP 8
75 .I -modulepath
76 Specifies where xorgcfg, and the server it may start, should look for
77 __xservername__ modules.
78 .TP 8
79 .I -serverpath
80 Specifies the complete path, not including the binary name, of the
81 __xservername__ binary.
82 .TP 8
83 .I -fontpath
84 Specifies the path to the fonts that should be used by the server started
85 by xorgcfg.
86 .TP 8
87 .I -rgbpath
88 Specifies the path to the rgb.txt file that should be used by the server
89 started by xorgcfg, if any.
90 .TP 8
91 .I -textmode
92 If xorgcfg was compiled with support for ncurses, this option makes xorgcfg
93 enter a text mode interface.
94 .TP 8
95 .I -nomodules
96 When built with support for loading modules, this options changes xorgcfg
97 behaviour, so that it will not load any modules, and thus start quicker.
99 .SH ENVIRONMENT
100 .TP 8
101 .I DISPLAY
102 Default host and display number.
103 .TP 8
104 .I XWINHOME
105 Directory where __xservername__ was installed, defaults to __projectroot__.
106 .TP 8
107 .I XENVIRONMENT
108 Name of a resource file that overrides the global resources
109 stored in the RESOURCE_MANAGER property.
111 .SH FILES
112 .TP 8
113 .I /etc/__xconfigfile__
114 Server configuration file
115 .TP 8
116 .I /etc/X11/__xconfigfile__
117 Server configuration file
118 .TP 8
119 .I __projectroot__/etc/__xconfigfile__
120 Server configuration file
121 .TP 8
122 .IR __projectroot__/lib/X11/__xconfigfile__. hostname
123 Server configuration file
124 .TP 8
125 .I __projectroot__/lib/X11/__xconfigfile__
126 Server configuration file
127 .TP 8
128 .I __projectroot__/lib/X11/app-default/XOrgCfg
129 Specifies xorgcfg resources
130 .TP 8
131 .I __projectroot__/lib/X11/xkb/X0-config.keyboard
132 Keyboard specific configuration
134 .SH "SEE ALSO"
135 .IR __xservername__ (__appmansuffix__),
136 .IR __xconfigfile__ (__filemansuffix__)
138 .SH COPYRIGHT
139 .TP 8
140 Copyright 2000, Conectiva Linux S.A.
141 \fIhttp://www.conectiva.com\fP
142 .TP 8
143 Copyright 2000, The XFree86 Project
144 \fIhttp://www.XFree86.org\fP
146 .SH AUTHORS
147 .TP 8
148 Paulo C\'esar Pereira de Andrade \fI<pcpa@conectiva.com.br>\fP
149 originally for The XFree86 Project.
151 .SH BUGS
152 Probably.