PageRenderTime 48ms CodeModel.GetById 46ms app.highlight 0ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-3-pre5/package-files/linux/jedit.1

#
Unknown | 162 lines | 135 code | 27 blank | 0 comment | 0 complexity | 65134176f2dcb3dd980207f1d05fad25 MD5 | raw file
  1.TH JEDIT 1 "June 14, 2006" jEdit "jEdit - Programmer's Text Editor"
  2
  3.SH NAME
  4.B jEdit
  5\- Programmer's Text Editor written in Java
  6
  7.SH SYNOPSIS
  8.B "jedit "
  9[
 10.B options
 11] [
 12.B files
 13]
 14
 15.SH DESCRIPTION
 16
 17This manual page briefly documents \fBjEdit\fP's command-line parameters.
 18Complete documentation can be found by invoking the Help->jEdit Help
 19menu item within \fBjEdit\fP or by invoking jedit -usage.
 20
 21\fBjEdit\fP  is a cross-platform text editor written in Java. It
 22has an extensive feature set that includes syntax highlighting, auto indent,
 23folding, word wrap, abbreviation expansion, multiple clipboards, powerful search
 24and replace and much more.
 25
 26Furthermore, \fBjEdit\fP is extremely customizable, and extensible, using either macros
 27written in the BeanShell scripting language, or plugins written in Java.
 28
 29\fBjEdit\fP requires Java 2 version 1.4.
 30
 31\fBjEdit\fP is released under the GNU General Public License, which can be found in
 32the online help.
 33.PP
 34
 35.SH GENERAL COMMAND LINE USAGE
 36
 37When opening files from the command line, a line number or marker to position 
 38the caret on can be specified like so:
 39
 40$ jedit MyApplet.java +line:10
 41
 42$ jedit thesis.tex +marker:c
 43
 44Command-line switches begin with a "-". Some take a parameter. A file whose name
 45begins with "-" can be opened like so:
 46
 47$ jedit -- -myfile
 48
 49.SH MISCELLANEOUS OPTIONS
 50
 51.TP
 52\fB\-log=level\fR
 53Set the minimum log level to an integer between 1 and 9. Default is 7.
 54Has no effect when connecting to 
 55another instance via the edit server.
 56.TP
 57\fB\-usage\fR
 58Show a brief command line usage message without starting \fBjEdit\fP. This message
 59is also shown if an invalid switch was specified.
 60.TP
 61\fB\-version\fR
 62Show the version number without starting \fBjEdit\fP.
 63.TP
 64\fB\--\fR
 65Specifies the end of command-line processing. Further parameters are treated
 66as file names, even if they begin with a dash.
 67
 68.SH CONFIGURATION OPTIONS
 69
 70.TP
 71\fB\-plugins\fR
 72Enable loading of plugins. This is the default. Has no effect
 73when connecting to another instance via the edit server.
 74.TP
 75\fB\-noplugins\fR
 76Disable loading of plugins. Has no effect
 77when connecting to another instance via the edit server.
 78.TP
 79\fB\-restore\fR
 80Restore previously open files on startup. This is the default.
 81.TP
 82\fB\-norestore\fR
 83Do not restore previously open files on startup.
 84.TP
 85\fB\-run=script\fR
 86Run the specified BeanShell script. There can only be one of these parameters 
 87on the command line.
 88.TP
 89\fB\-settings=dir\fR
 90Store user-specific settings in the directory named "dir", instead
 91of the default $HOME/.jedit. The directory will be created automatically 
 92if it does not exist. Has no effect when connecting to another instance via 
 93the edit server.
 94.TP
 95\fB\-nosettings\fR
 96Start \fBjEdit\fP without loading user-specific settings.
 97.TP
 98\fB\-startupscripts\fR
 99Run startup scripts. This is the default. Has no effect when connecting to 
100another instance via the edit server.
101.TP
102\fB\-nostartupscripts\fR
103Disable startup scripts. Has no effect when connecting to 
104another instance via the edit server.
105
106.SH EDIT SERVER OPTIONS
107
108For information about the edit server, see the section "Starting jEdit" in
109the \fBjEdit\fP online help.
110
111.TP
112\fB\-background\fR
113Run \fBjEdit\fP in background mode. In background mode, the edit server will continue
114listening for client connections even after all views are closed. Has no effect
115when connecting to another instance via the edit server.
116.TP
117\fB\-nobackground\fR
118Disable background mode. This is the default. Has no effect when connecting to 
119another instance via the edit server.
120.TP
121\fB\-gui\fR
122Open an initial view. This is the
123default. Has no effect when connecting to 
124another instance via the edit server.
125.TP
126\fB\-nogui\fR
127Do not open an initial view, and instead only open one when the first 
128client connects. Can only be used in combination with the -background switch. 
129You can use this switch to "pre-load" \fBjEdit\fP when you log in to your computer, 
130for example. Has no effect when connecting to 
131another instance via the edit server.
132.TP
133\fB\-server\fR
134Store the server port info in the file named "server" inside the settings 
135directory. This is the default.
136.TP
137\fB\-server=name\fR
138Store the server port info in the file named "name". File names for this 
139parameter are relative to the settings directory.
140.TP
141\fB\-noserver\fR
142Do not attempt to connect to a running edit server, and does not start one 
143either.
144
145.SH FILES
146
147.TP
148~/.jedit
149Each user who runs \fBjEdit\fP has a settings directory. Its content is documented
150in the "Customizing jEdit" section of the online help.
151
152.SH "SEE ALSO"
153.BR java (1)
154
155.SH VERSION
156\fBjEdit\fP @jedit.version@
157
158.SH BUGS
159See http://www.jEdit.org/index.php?page=feedback for bug reporting information.
160
161.SH WEB
162http://www.jEdit.org/