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

.TH JEDIT 1 "June 14, 2006" jEdit "jEdit - Programmer's Text Editor"

.SH NAME
.B jEdit
\- Programmer's Text Editor written in Java

.SH SYNOPSIS
.B "jedit "
[
.B options
] [
.B files
]

.SH DESCRIPTION

This manual page briefly documents \fBjEdit\fP's command-line parameters.
Complete documentation can be found by invoking the Help->jEdit Help
menu item within \fBjEdit\fP or by invoking jedit -usage.

\fBjEdit\fP  is a cross-platform text editor written in Java. It
has an extensive feature set that includes syntax highlighting, auto indent,
folding, word wrap, abbreviation expansion, multiple clipboards, powerful search
and replace and much more.

Furthermore, \fBjEdit\fP is extremely customizable, and extensible, using either macros
written in the BeanShell scripting language, or plugins written in Java.

\fBjEdit\fP requires Java 2 version 1.4.

\fBjEdit\fP is released under the GNU General Public License, which can be found in
the online help.
.PP

.SH GENERAL COMMAND LINE USAGE

When opening files from the command line, a line number or marker to position 
the caret on can be specified like so:

$ jedit MyApplet.java +line:10

$ jedit thesis.tex +marker:c

Command-line switches begin with a "-". Some take a parameter. A file whose name
begins with "-" can be opened like so:

$ jedit -- -myfile

.SH MISCELLANEOUS OPTIONS

.TP
\fB\-log=level\fR
Set the minimum log level to an integer between 1 and 9. Default is 7.
Has no effect when connecting to 
another instance via the edit server.
.TP
\fB\-usage\fR
Show a brief command line usage message without starting \fBjEdit\fP. This message
is also shown if an invalid switch was specified.
.TP
\fB\-version\fR
Show the version number without starting \fBjEdit\fP.
.TP
\fB\--\fR
Specifies the end of command-line processing. Further parameters are treated
as file names, even if they begin with a dash.

.SH CONFIGURATION OPTIONS

.TP
\fB\-plugins\fR
Enable loading of plugins. This is the default. Has no effect
when connecting to another instance via the edit server.
.TP
\fB\-noplugins\fR
Disable loading of plugins. Has no effect
when connecting to another instance via the edit server.
.TP
\fB\-restore\fR
Restore previously open files on startup. This is the default.
.TP
\fB\-norestore\fR
Do not restore previously open files on startup.
.TP
\fB\-run=script\fR
Run the specified BeanShell script. There can only be one of these parameters 
on the command line.
.TP
\fB\-settings=dir\fR
Store user-specific settings in the directory named "dir", instead
of the default $HOME/.jedit. The directory will be created automatically 
if it does not exist. Has no effect when connecting to another instance via 
the edit server.
.TP
\fB\-nosettings\fR
Start \fBjEdit\fP without loading user-specific settings.
.TP
\fB\-startupscripts\fR
Run startup scripts. This is the default. Has no effect when connecting to 
another instance via the edit server.
.TP
\fB\-nostartupscripts\fR
Disable startup scripts. Has no effect when connecting to 
another instance via the edit server.

.SH EDIT SERVER OPTIONS

For information about the edit server, see the section "Starting jEdit" in
the \fBjEdit\fP online help.

.TP
\fB\-background\fR
Run \fBjEdit\fP in background mode. In background mode, the edit server will continue
listening for client connections even after all views are closed. Has no effect
when connecting to another instance via the edit server.
.TP
\fB\-nobackground\fR
Disable background mode. This is the default. Has no effect when connecting to 
another instance via the edit server.
.TP
\fB\-gui\fR
Open an initial view. This is the
default. Has no effect when connecting to 
another instance via the edit server.
.TP
\fB\-nogui\fR
Do not open an initial view, and instead only open one when the first 
client connects. Can only be used in combination with the -background switch. 
You can use this switch to "pre-load" \fBjEdit\fP when you log in to your computer, 
for example. Has no effect when connecting to 
another instance via the edit server.
.TP
\fB\-server\fR
Store the server port info in the file named "server" inside the settings 
directory. This is the default.
.TP
\fB\-server=name\fR
Store the server port info in the file named "name". File names for this 
parameter are relative to the settings directory.
.TP
\fB\-noserver\fR
Do not attempt to connect to a running edit server, and does not start one 
either.

.SH FILES

.TP
~/.jedit
Each user who runs \fBjEdit\fP has a settings directory. Its content is documented
in the "Customizing jEdit" section of the online help.

.SH "SEE ALSO"
.BR java (1)

.SH VERSION
\fBjEdit\fP @jedit.version@

.SH BUGS
See http://www.jEdit.org/index.php?page=feedback for bug reporting information.

.SH WEB
http://www.jEdit.org/