usr/src/cmd/jedit/jedit.1
changeset 0 b34509ac961f
child 11 87960ed158f9
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/usr/src/cmd/jedit/jedit.1	Wed Oct 21 17:43:30 2009 +0200
@@ -0,0 +1,208 @@
+'\" t
+.\"
+.\" CDDL HEADER START
+.\"
+.\" The contents of this file are subject to the terms of the
+.\" Common Development and Distribution License (the "License").
+.\" You may not use this file except in compliance with the License.
+.\"
+.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
+.\" or http://www.opensolaris.org/os/licensing.
+.\" See the License for the specific language governing permissions
+.\" and limitations under the License.
+.\"
+.\" When distributing Covered Code, include this CDDL HEADER in each
+.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
+.\" If applicable, add the following below this CDDL HEADER, with the
+.\" fields enclosed by brackets "[]" replaced with your own identifying
+.\" information: Portions Copyright [yyyy] [name of copyright owner]
+.\"
+.\" CDDL HEADER END
+.\"
+.\" Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
+.\" Use is subject to license terms.
+.\"
+.\" ident	"@(#)jedit.1	1.1	09/07/10 SMI"	
+.\"
+.\" This man page created by Sun Microsystems to provide a reference to the documents 
+.\" for jEdit provided with the jEdit distribution.
+.\"
+.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. With plugins, you can create a very powerful development environment
+for HTML, XML, C/C++, Python, Perl, Ruby, Lisp, Scheme, and many others.
+
+\fBjEdit\fP Requires Sun Java 2 version 1.5.
+
+\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
+/usr/share/jedit/jedit.jar
+.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 VERSION
+\fBjEdit\fP 4.3pre16
+
+.SH BUGS
+See http://www.jEdit.org/index.php?page=feedback for bug reporting information.
+.SH ATTRIBUTES
+See
+.BR attributes (5)
+for descriptions of the following attributes:
+.sp
+.TS
+box;
+cbp-1 | cbp-1
+l | l .
+ATTRIBUTE TYPE	ATTRIBUTE VALUE
+=
+Availablility	SUNWjedit
+=
+Interface Stability	Uncommitted
+.TE
+
+.SH "SEE ALSO"
+.BR java (1)
+
+.SH NOTES
+In addition to the documentation and man pages included with Solaris/OpenSolaris, more information is available at http://www.jedit.org
+
+Source for jedit is available on http://opensolaris.org.