doc/nedit.man

   1 .\" Automatically generated by Pod::Man version 1.02
   2 .\" Wed Aug 22 08:20:45 2001
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` `
  50 .    ds C' '
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 .    .
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "NEDIT 1"
 141 .TH NEDIT 1 " " "2001-08-22" " "
 142 .UC
 143 .SH "NAME"
 144 NEdit \- Text Editor
 145 .SH "SYNOPSYS"
 146 .IX Header "SYNOPSYS"
 147 nedit [\fB\-read\fR] [\fB\-create\fR] [\fB\-line\fR \fIn\fR | \fB+\fR\fIn\fR] [\fB\-server\fR] [\fB\-do\fR
 148 \&\fIcommand\fR] [\fB\-tags\fR \fIfile\fR] [\fB\-tabs\fR \fIn\fR] [\fB\-wrap\fR] [\fB\-nowrap\fR]
 149 [\fB\-autowrap\fR] [\fB\-autoindent\fR] [\fB\-noautoindent\fR] [\fB\-autosave\fR]
 150 [\fB\-noautosave\fR] [\fB\-lm\fR \fIlanguagemode\fR] [\fB\-rows\fR n] [\fB\-columns\fR \fIn\fR]
 151 [\fB\-font\fR \fIfont\fR] [\fB\-geometry\fR \fIgeometry\fR] [\fB\-iconic\fR] [\fB\-noiconic\fR]
 152 [\fB\-display\fR \fI[host]:server[.screen]\fR] [\fB\-xrm\fR \fIresourcestring\fR]
 153 [\fB\-svrname\fR \fIname\fR] [\fB\-import\fR \fIfile\fR] [\fB\-background\fR \fIcolor\fR]
 154 [\fB\-foreground\fR \fIcolor\fR] [\fB\-V\fR] [\fB\-version\fR] [file...]
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 NEdit is a standard \s-1GUI\s0 (Graphical User Interface) style text editor for
 158 programs and plain-text files. It provides mouse based editing and a
 159 streamlined editing style, based on popular Macintosh and \s-1MS\s0 Windows editors,
 160 for users of X workstations and X terminals.
 161 .SH "OPTIONS"
 162 .IX Header "OPTIONS"
 163 .Ip "\fB\-read\fR" 4
 164 .IX Item "-read"
 165 Open the file read-only regardless of the actual file protection.
 166 .Ip "\fB\-create\fR" 4
 167 .IX Item "-create"
 168 Don't warn about file creation when a file doesn't exist.
 169 .Ip "\fB\-line\fR \fIn\fR, \fB+\fR\fIn\fR" 4
 170 .IX Item "-line n, +n"
 171 Go to line number \fIn\fR.
 172 .Ip "\fB\-server\fR" 4
 173 .IX Item "-server"
 174 Designate this session as an NEdit server, for processing commands from the
 175 \&\fInc\fR\|(1) program. \fInc\fR\|(1) can be used to interface NEdit to code development
 176 environments, mailers, etc., or just as a quick way to open files from the
 177 shell command line without starting a new NEdit session.
 178 .Ip "\fB\-do\fR \fIcommand\fR" 4
 179 .IX Item "-do command"
 180 Execute an NEdit macro or action. On each file following the \fB\-do\fR argument on
 181 the command line. \fB\-do\fR is particularly useful from the \fInc\fR\|(1) program, where
 182 \&\f(CW\*(C`nc \-do\*(C'\fR can remotely execute commands in an nedit \fB\-server\fR session.
 183 .Ip "\fB\-tags\fR \fIfile\fR" 4
 184 .IX Item "-tags file"
 185 Load a file of directions for finding definitions of program subroutines and
 186 data objects. The file must be of the format generated by Exuberant Ctags, or
 187 the standard Unix \fIctags\fR\|(1) command.
 188 .Ip "\fB\-tabs\fR \fIn\fR" 4
 189 .IX Item "-tabs n"
 190 Set tab stops every \fIn\fR characters.
 191 .Ip "\fB\-wrap\fR, \fB\-nowrap\fR" 4
 192 .IX Item "-wrap, -nowrap"
 193 Wrap long lines at the right edge of the window rather than continuing them
 194 past it. (Continuous Wrap mode)
 195 .Ip "\fB\-autowrap\fR, \fB\-noautowrap\fR" 4
 196 .IX Item "-autowrap, -noautowrap"
 197 Wrap long lines when the cursor reaches the right edge of the window by
 198 inserting newlines at word boundaries. (Auto Newline Wrap mode)
 199 .Ip "\fB\-autoindent\fR, \fB\-noautoindent\fR" 4
 200 .IX Item "-autoindent, -noautoindent"
 201 Maintain a running indent.
 202 .Ip "\fB\-autosave\fR, \fB\-noautosave\fR" 4
 203 .IX Item "-autosave, -noautosave"
 204 Maintain a backup copy of the file being edited under the name \fI~filename\fR
 205 (on Unix) or \fI_filename\fR (on \s-1VMS\s0).
 206 .Ip "\fB\-lm\fR \fIlanguagemode\fR" 4
 207 .IX Item "-lm languagemode"
 208 Initial language mode used for editing succeeding files.
 209 .Ip "\fB\-rows\fR \fIn\fR" 4
 210 .IX Item "-rows n"
 211 Default height in characters for an editing window.
 212 .Ip "\fB\-columns\fR \fIn\fR" 4
 213 .IX Item "-columns n"
 214 Default width in characters for an editing window.
 215 .Ip "\fB\-font\fR \fIfont\fR, \fB\-fn\fR \fIfont\fR" 4
 216 .IX Item "-font font, -fn font"
 217 Font for text being edited. Font for menus and dialogs can be set with \fB\-xrm\fR
 218 \&\fI\*(L"*fontList:font\*(R"\fR.
 219 .Ip "\fB\-geometry\fR \fIgeometry\fR, \fB\-g\fR \fIgeometry\fR" 4
 220 .IX Item "-geometry geometry, -g geometry"
 221 The initial size and/or location of editor windows. The argument geometry has
 222 the form:
 223 .Sp
 224 .Vb 1
 225 \&  [<width>x<height>][+|-][<xoffset>[+|-]<yoffset>]
 226 .Ve
 227 where \f(CW\*(C`<width>\*(C'\fR and \f(CW\*(C`<height>\*(C'\fR are the desired width and
 228 height of the window, and \f(CW\*(C`<xoffset>\*(C'\fR and \f(CW\*(C`<yoffset>\*(C'\fR are the
 229 distance from the edge of the screen to the window, + for top or left, \- for
 230 bottom or right. \fB\-geometry\fR can be specified for individual files on the
 231 command line.
 232 .Ip "\fB\-iconic\fR, \fB\-noiconic\fR" 4
 233 .IX Item "-iconic, -noiconic"
 234 Initial window state for succeeding files.
 235 .Ip "\fB\-display\fR \fI[host]:server[.screen]\fR" 4
 236 .IX Item "-display [host]:server[.screen]"
 237 The name of the X server to use. \fIhost\fR specifies the machine, \fIserver\fR
 238 specifies the display server number, and \fIscreen\fR specifies the screen number.
 239 \&\fIhost\fR or \fIscreen\fR can be omitted and default to the local machine, and
 240 screen 0.
 241 .Ip "\fB\-background\fR \fIcolor\fR, \fB\-bg\fR \fIcolor\fR" 4
 242 .IX Item "-background color, -bg color"
 243 Background color. The background color for text can be set separately with
 244 \&\fB\-xrm\fR \fI\*(L"nedit*text.background: color\*(R"\fR.
 245 .Ip "\fB\-foreground\fR \fIcolor\fR, \fB\-fg\fR \fIcolor\fR" 4
 246 .IX Item "-foreground color, -fg color"
 247 Foreground color. The foreground color for text can be set separately with
 248 \&\fB\-xrm\fR \fI\*(L"nedit*text.foreground: color\*(R"\fR.
 249 .Ip "\fB\-xrm\fR \fIresourcestring\fR" 4
 250 .IX Item "-xrm resourcestring"
 251 Set the value of an X resource to override a default value.
 252 .Ip "\fB\-svrname\fR \fIname\fR" 4
 253 .IX Item "-svrname name"
 254 When starting nedit in server mode, name the server, such that it responds to
 255 requests only when \fInc\fR\|(1) is given a corresponding \fB\-svrname\fR argument.  By
 256 naming servers, you can run several simultaneously, and direct files and
 257 commands specifically to any one.
 258 .Ip "\fB\-import\fR \fIfile\fR" 4
 259 .IX Item "-import file"
 260 Loads an additional preferences file on top of the existing defaults saved in
 261 your \fI.nedit\fR file.  To incorporate macros, language modes, and highlight
 262 patterns and styles written by other users, run nedit with \fB\-import\fR
 263 \&\fI<file>\fR, then re-save your \fI.nedit\fR file with
 264 Preferences->Save\ Defaults.
 265 .Ip "\fB\-V\fR, \fB\-version\fR" 4
 266 .IX Item "-V, -version"
 267 Prints version and build information, to be mentioned when reporting bugs and
 268 problems. Also prints credits and license information.
 269 .SH "ENVIRONMENT"
 270 .IX Header "ENVIRONMENT"
 271 .Ip "\s-1DISPLAY\s0" 4
 272 .IX Item "DISPLAY"
 273 NEdit requires an X-based workstation or X-Terminal. If you have used  telnet
 274 or rlogin to access the host Unix system, set the Unix environment variable for
 275 your display:
 276 .Sp
 277 .Vb 1
 278 \&    % setenv DISPLAY devicename:0
 279 .Ve
 280 .SH "FILES"
 281 .IX Header "FILES"
 282 NEdit stores a few files in a user's home directory:
 283 .Ip "\fI.nedit\fR" 4
 284 .IX Item ".nedit"
 285 The general configuration file. Do not edit this file by hand.
 286 .Ip "\fI.neditmacro\fR" 4
 287 .IX Item ".neditmacro"
 288 A file that can contain a number of macro statements and subroutines. The
 289 statements will be executed when a NEdit server starts, the subroutines will be
 290 loaded for later reference.
 291 .Ip "\fI.neditdb\fR" 4
 292 .IX Item ".neditdb"
 293 The list of recently opened files. Do not edit this file by hand.
 294 .SH "NOTES"
 295 .IX Header "NOTES"
 296 For more information see NEdit's online help, or nedit.doc in the NEdit
 297 distribution kit.
 298 .PP
 299 NEdit sources, executables, additional documentation, and contributed software
 300 are available from the NEdit web site at http://nedit.org.
 301 .SH "SEE ALSO"
 302 .IX Header "SEE ALSO"
 303 \&\fInc\fR\|(1), X(1), \fImwm\fR\|(1), \fIvi\fR\|(1), \fIemacs\fR\|(1), \fIctags\fR\|(1)
 304 .SH "AUTHORS"
 305 .IX Header "AUTHORS"
 306 NEdit was written by Mark Edel, Joy Kyriakopulos, Christopher Conrad, Jim
 307 Clark, Arnulfo Zepeda-Navratil, Suresh Ravoor, Tony Balinski, Max Vohlken,
 308 Yunliang Yu, Donna Reid, Arne Forlie, Eddy De Greef, Steve LoBasso, Alexander
 309 Mai, Scott Tringali, and Thorsten Haude.
 310 .PP
 311 The regular expression matching routines used in NEdit are adapted (with
 312 permission) from original code written by Henry Spencer at the University of
 313 Toronto.
 314 .PP
 315 Syntax highlighting patterns and smart indent macros were contributed by: Simon
 316 T. MacDonald,  Maurice Leysens, Matt Majka, Alfred Smeenk, Alain Fargues,
 317 Christopher Conrad, Scott Markinson, Konrad Bernloehr, Ivan Herman, Patrice
 318 Venant, Christian Denat, Philippe Couton, Max Vohlken, Markus Schwarzenberg,
 319 Himanshu Gohel, Steven C. Kapp, Michael Turomsha, John Fieber, Chris Ross,
 320 Nathaniel Gray, Joachim Lous, Mike Duigou, Seak Teng-Fong, Joor Loohuis,
 321 Mark Jones, and Niek van den Berg.
 322 .SH "COPYRIGHT"
 323 .IX Header "COPYRIGHT"
 324 This program is free software; you can redistribute it and/or modify it under
 325 the terms of the \s-1GNU\s0 General Public License as published by the Free Software
 326 Foundation; either version 2 of the License, or (at your option) any later
 327 version.
 328 .PP
 329 This program is distributed in the hope that it will be useful, but \s-1WITHOUT\s0 \s-1ANY\s0
 330 \&\s-1WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A
 331 \&\s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the \s-1GNU\s0 General Public License in the Help section
 332 \&\*(L"Distribution Policy\*(R" for more details.