1 # $Id: xnedit.pod,v 1.9 2005/06/20 10:54:45 edg Exp $
2 =pod
3
4 =head1 NAME
5
6 XNEdit - Text Editor
7
8 =head1 SYNOPSYS
9
10 xnedit [B<-read>] [B<-create>] [B<-line> I<n> | B<+>I<n>] [B<-server>]
11 [B<-do> I<command>] [B<-tags> I<file>] [B<-tabs> I<n>]
12 [B<-wrap>] [B<-nowrap>] [B<-autowrap>]
13 [B<-autoindent>] [B<-noautoindent>]
14 [B<-autosave>] [B<-noautosave>]
15 [B<-lm> I<languagemode>] [B<-rows> n] [B<-columns> I<n>]
16 [B<-font> I<font>]
17 [B<-geometry>|B<-g> I<geometry>] [B<-iconic>] [B<-noiconic>]
18 [B<-display> I<[host]:server[.screen]>]
19 [B<-xrm> I<resourcestring>]
20 [B<-svrname> I<name>] [B<-import> I<file>]
21 [B<-background>|B<-bg> I<color>] [B<-foreground>|B<-fg> I<color>]
22 [B<-tabbed>] [B<-untabbed>] [B<-group>]
23 [B<-V|-version>] [B<-h|-help>] [B<-->] [file...]
24
25 =head1 DESCRIPTION
26
27 XNEdit is a standard GUI (Graphical User Interface) style text editor for
28 programs and plain-text files. It provides mouse based editing and a
29 streamlined editing style, based on popular Macintosh and MS Windows editors,
30 for users of X workstations and X terminals.
31
32 =head1 OPTIONS
33
34 =over
35
36 =item B<-read>
37
38 Open the file read-only regardless of the actual file protection.
39
40 =item B<-create>
41
42 Don't warn about file creation when a file doesn't exist.
43
44 =item B<-line> I<n>, B<+>I<n>
45
46 Go to line number I<n>.
47
48 =item B<-server>
49
50 Designate this session as an XNEdit server, for processing commands from the
51 L<nc(1)> program. L<nc(1)> can be used to interface XNEdit to code development
52 environments, mailers, etc., or just as a quick way to open files from the
53 shell command line without starting a new XNEdit session.
54
55 =item B<-do> I<command>
56
57 Execute an XNEdit macro or action on the file following the -do argument on the
58 command line. B<-do> is particularly useful from the L<nc(1)> program, where
59 `nc -do' can remotely execute commands in an xnedit B<-server> session.
60
61 =item B<-tags> I<file>
62
63 Load a file of directions for finding definitions of program subroutines and
64 data objects. The file must be of the format generated by Exuberant Ctags, or
65 the standard Unix L<ctags(1)> command.
66
67 =item B<-tabs> I<n>
68
69 Set tab stops every I<n> characters.
70
71 =item B<-wrap>, B<-nowrap>
72
73 Wrap long lines at the right edge of the window rather than continuing them
74 past it. (Continuous Wrap mode)
75
76 =item B<-autowrap>, B<-noautowrap>
77
78 Wrap long lines when the cursor reaches the right edge of the window by
79 inserting newlines at word boundaries. (Auto Newline Wrap mode)
80
81 =item B<-autoindent>, B<-noautoindent>
82
83 Maintain a running indent.
84
85 =item B<-autosave>, B<-noautosave>
86
87 Maintain a backup copy of the file being edited under the name I<~filename>
88 (on Unix) or I<_filename> (on VMS).
89
90 =item B<-lm> I<languagemode>
91
92 Initial language mode used for editing succeeding files.
93
94 =item B<-rows> I<n>
95
96 Default height in characters for an editing window.
97
98 =item B<-columns> I<n>
99
100 Default width in characters for an editing window.
101
102 =item B<-font> I<font>, B<-fn> I<font>
103
104 Font for text being edited. Font for menus and dialogs can be set with B<-xrm>
105 I<"*fontList:font">.
106
107 =item B<-geometry> I<geometry>, B<-g> I<geometry>
108
109 The initial size and/or location of editor windows. The argument geometry has
110 the form:
111
112 [<width>x<height>][+|-][<xoffset>[+|-]<yoffset>]
113
114 where C`<width>' and C<< <height> >> are the desired width and
115 height of the window, and <xoffset> and C`<yoffset>' are the
116 distance from the edge of the screen to the window, + for top or left, - for
117 bottom or right. B<-geometry> can be specified for individual files on the
118 command line.
119
120 =item B<-iconic>, B<-noiconic>
121
122 Initial window state for succeeding files.
123
124 =item B<-display> I<[host]:server[.screen]>
125
126 The name of the X server to use. I<host> specifies the machine, I<server>
127 specifies the display server number, and I<screen> specifies the screen number.
128 I<host> or I<screen> can be omitted and default to the local machine, and
129 screen 0.
130
131 =item B<-background> I<color>, B<-bg> I<color>
132
133 Background color. The background color for text can be set separately with
134 B<-xrm> I<"nedit*text.background: color">.
135
136 =item B<-foreground> I<color>, B<-fg> I<color>
137
138 Foreground color. The foreground color for text can be set separately with
139 B<-xrm> I<"nedit*text.foreground: color">.
140
141 =item B<-xrm> I<resourcestring>
142
143 Set the value of an X resource to override a default value.
144
145 =item B<-svrname> I<name>
146
147 When starting xnedit in server mode, name the server, such that it responds to
148 requests only when L<nc(1)> is given a corresponding B<-svrname> argument. By
149 naming servers, you can run several simultaneously, and direct files and
150 commands specifically to any one. Specifying a non-empty name automatically
151 designates this session as an XNEdit server, as though B<-server> were specified.
152
153 =item B<-import> I<file>
154
155 Loads an additional preferences file on top of the existing defaults saved in
156 your I<nedit.rc> file. To incorporate macros, language modes, and highlight
157 patterns and styles written by other users, run xnedit with B<-import>
158 I<<file>>, then re-save your I<nedit.rc> file with
159 Preferences->Save Defaults.
160
161 =item B<-tabbed>
162
163 Open all subsequent files in new tabs. Resets B<-group> option.
164
165 =item B<-untabbed>
166
167 Open all subsequent files in new windows. Resets B<-group> option.
168
169 =item B<-group>
170
171 Open all subsequent files as tabs in a new window.
172
173 =item B<-V>, B<-version>
174
175 Prints version and build information, to be mentioned when reporting bugs and
176 problems.
177
178 =item B<-h>, B<-help>
179
180 Prints the command line help and then exits.
181
182 =item B<-->
183
184 Treats all subsequent arguments as file names, even if they start with a dash.
185 This is so XNEdit can access files that begin with the dash character.
186
187 =back
188
189 =head1 ENVIRONMENT
190
191 =over
192
193 =item DISPLAY
194
195 XNEdit requires an X-based workstation or X-Terminal. If you have used B<telnet>
196 or B<rlogin> to access the host Unix system, set the Unix environment variable for
197 your display:
198
199 csh-type shells:
200
201 % setenv DISPLAY devicename:0
202
203 sh-type shells:
204
205 % DISPLAY=devicename:0 && export DISPLAY
206
207 =item NEDIT_HOME
208
209 This environment variable can be set to the name of a
210 directory. This directory will then be used instead of
211 `$HOME/.xnedit' as the base directory for XNEdit's special
212 files (see section FILES, below).
213
214 =back
215
216 =head1 FILES
217
218 XNEdit creates a directory in which XNEdit's
219 special files reside. This directory is named '.xnedit' by default.
220
221 =over
222
223 =item I<nedit.rc>
224
225 This is an X resource file which contains most user settings for
226 XNEdit. It is read at startup and written by selecting the item
227 'Save Defaults...' in the Preferences menu. Do not edit this
228 file by hand, all settings can be reached via the 'Default
229 Settings' menu.
230
231 =item I<nedit.history>
232
233 The list of recently opened files. Do not edit this
234 file by hand.
235
236 =item I<autoload.nm >
237
238 A file that can contain a number of XNEdit Macro Language
239 statements and subroutine definitions. The statements will be
240 executed when an XNEdit server starts, the subroutines will be
241 loaded for later reference.
242 This file will not be created or modified by XNEdit (unless
243 you load it and edit it of course).
244
245 =back
246
247
248 Note that NEdit still supports the older names for these files,
249 which were used by version 5.3 and below. These file names
250 are `$HOME/.nedit', `$HOME/.neditdb' and `$HOME/.neditmacro',
251 respectively. The old naming scheme will be used if NEdit
252 detects that `$HOME/.nedit' is a regular file and NEDIT_HOME
253 isn't set.
254
255 See also the entry for NEDIT_HOME under ENVIRONMENT, above.
256
257 =head1 NOTES
258
259 For more information see XNEdit's online help, or xnedit.txt in the XNEdit
260 distribution kit.
261
262 XNEdit sources, executables, additional documentation, and contributed software
263 are available from the XNEdit web site at https://unixwork.de/xnedit/
264
265 =head1 SEE ALSO
266
267 nc(1), X(1), mwm(1), ctags(1), etags(1)
268
269 =head1 AUTHORS
270
271 XNEdit was written by Olaf Winterman, Mark Edel, Joy Kyriakopulos, Christopher
272 Conrad, Jim Clark, Arnulfo Zepeda-Navratil, Suresh Ravoor, Tony Balinski, Max
273 Vohlken, Yunliang Yu, Donna Reid, Arne Forlie, Eddy De Greef, Steve LoBasso,
274 Alexander Mai, Scott Tringali, Thorsten Haude, Steve Haehn, Andrew Hood,
275 Nathaniel Gray and TK Soh.
276
277 The regular expression matching routines used in XNEdit are adapted (with
278 permission) from original code written by Henry Spencer at the University of
279 Toronto.
280
281 Syntax highlighting patterns and smart indent macros were contributed by: Simon
282 T. MacDonald, Maurice Leysens, Matt Majka, Alfred Smeenk, Alain Fargues,
283 Christopher Conrad, Scott Markinson, Konrad Bernloehr, Ivan Herman, Patrice
284 Venant, Christian Denat, Philippe Couton, Max Vohlken, Markus Schwarzenberg,
285 Himanshu Gohel, Steven C. Kapp, Michael Turomsha, John Fieber, Chris Ross,
286 Nathaniel Gray, Joachim Lous, Mike Duigou, Seak Teng-Fong, Joor Loohuis,
287 Mark Jones, and Niek van den Berg.
288
289 =head1 COPYRIGHT
290
291 This program is free software; you can redistribute it and/or modify it under
292 the terms of the GNU General Public License as published by the Free Software
293 Foundation; either version 2 of the License, or (at your option) any later
294 version.
295
296 In addition, as a special exception to the GNU GPL, the copyright holders give
297 permission to link the code of this program with the Motif and Open Motif
298 libraries (or with modified versions of these that use the same license), and
299 distribute linked combinations including the two. You must obey the GNU General
300 Public License in all respects for all of the code used other than linking with
301 Motif/Open Motif. If you modify this file, you may extend this exception to your
302 version of the file, but you are not obligated to do so. If you do not wish to
303 do so, delete this exception statement from your version.
304
305 This program is distributed in the hope that it will be useful, but WITHOUT ANY
306 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
307 PARTICULAR PURPOSE. See the GNU General Public License in the Help section
308 "Distribution Policy" for more details.
309
310 =cut
311