PageRenderTime 42ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/users-guide/cli-usage.html

#
HTML | 69 lines | 69 code | 0 blank | 0 comment | 0 complexity | 264d0e80dd1e2922b8c08fe14c8159c2 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Command Line Usage</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="jEdit 4.3 User's Guide"><link rel="up" href="starting.html" title="Chapter 2. Starting jEdit"><link rel="prev" href="starting.html" title="Chapter 2. Starting jEdit"><link rel="next" href="basics.html" title="Chapter 3. jEdit Basics"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Command Line Usage</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="starting.html">Prev</a> </td><th width="60%" align="center">Chapter 2. Starting jEdit</th><td width="20%" align="right"> <a accesskey="n" href="basics.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="cli-usage"></a>Command Line Usage</h2></div></div></div><p>On operating systems that support a command line, jEdit can be
    2. 

  2.         passed various arguments to control its behavior.</p><p>When opening files from the command line, a line number or marker
    3. 

  3.         to position the caret on can be specified like so:</p><pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>jedit MyApplet.java +line:10</code></strong>
    4. 

  4. <code class="prompt">$ </code><strong class="userinput"><code>jedit thesis.tex +marker:c</code></strong></pre><p>Command-line switches begin with a "-". Some take a parameter. A
    5. 

  5.         file whose name begins with "-" can be opened like so:</p><pre class="screen"><code class="prompt">$ </code><strong class="userinput"><code>jedit -- -myfile</code></strong></pre><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2496548"></a>Miscellaneous Options</h3></div></div></div><div class="informaltable"><table border="1"><colgroup><col><col></colgroup><thead><tr><th>Option</th><th>Effect</th></tr></thead><tbody><tr><td><strong class="userinput"><code>-log=<em class="replaceable"><code>level</code></em></code></strong></td><td>Set the minimum log level to an integer
    6. 

  6.                             between 1 and 9. Default is 7. Has no effect when
    7. 

  7.                             connecting to another instance via the edit
    8. 

  8.                             server.</td></tr><tr><td><strong class="userinput"><code>-usage</code></strong></td><td>Show a brief command line usage message
    9. 

  9.                             without starting jEdit. This message is also shown if
    10. 

  10.                             an invalid switch was specified.</td></tr><tr><td><strong class="userinput"><code>-version</code></strong></td><td>Show the version number without starting
    11. 

  11.                             jEdit.</td></tr><tr><td><strong class="userinput"><code>--</code></strong></td><td>Specifies the end of command-line processing.
    12. 

  12.                             Further parameters are treated as file names, even if
    13. 

  13.                             they begin with a dash.</td></tr></tbody></table></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2496657"></a>Configuration Options</h3></div></div></div><div class="informaltable"><table border="1"><colgroup><col><col></colgroup><thead><tr><th>Option</th><th>Effect</th></tr></thead><tbody><tr><td><strong class="userinput"><code>-plugins</code></strong></td><td>Enable loading of plugins. Has no effect when
    14. 

  14.                             connecting to another instance via the edit server.
    15. 

  15.                             See <a class="xref" href="using-plugins.html" title="Chapter 9. Installing and Using Plugins">Chapter 9, <i>Installing and Using Plugins</i></a>.</td></tr><tr><td><strong class="userinput"><code>-noplugins</code></strong></td><td>Disable loading of plugins. Has no effect when
    16. 

  16.                             connecting to another instance via the edit
    17. 

  17.                             server.</td></tr><tr><td><strong class="userinput"><code>-restore</code></strong></td><td>Restore previously open files on startup. This
    18. 

  18.                             is the default. This feature can also be set
    19. 

  19.                             permanently in the <span class="guibutton"><strong>General</strong></span>
    20. 

  20.                             pane of the
    21. 

  21.                             <span class="guimenu"><strong>Utilities</strong></span>&gt;<span class="guimenuitem"><strong>Global
    22. 

  22.                             Options</strong></span> dialog box; see <a class="xref" href="global-opts.html#general-pane" title="The General Pane">the section called &#8220;The General Pane&#8221;</a>.</td></tr><tr><td><strong class="userinput"><code>-norestore</code></strong></td><td>Do not restore previously open files on
    23. 

  23.                             startup.</td></tr><tr><td><strong class="userinput"><code>-run=<em class="replaceable"><code>script</code></em></code></strong></td><td>Run the specified BeanShell script. There can
    24. 

  24.                             only be one of these parameters on the command line.
    25. 

  25.                             See <a class="xref" href="scripts-command-line.html" title="Running Scripts from the Command Line">the section called &#8220;Running Scripts from the Command Line&#8221;</a>.</td></tr><tr><td><strong class="userinput"><code>-settings=<em class="replaceable"><code>dir</code></em></code></strong></td><td>Store user-specific settings in the directory
    26. 

  26.                             named <em class="replaceable"><code>dir</code></em>, instead of the
    27. 

  27.                             default
    28. 

  28.                             <code class="filename"><em class="replaceable"><code>user.home</code></em>/.jedit</code>.
    29. 

  29.                             The directory will be created automatically if it
    30. 

  30.                             does not exist. Has no effect when connecting to
    31. 

  31.                             another instance via the edit server. See <a class="xref" href="settings-directory.html" title="The jEdit Settings Directory">the section called &#8220;The jEdit Settings Directory&#8221;</a>.</td></tr><tr><td><strong class="userinput"><code>-nosettings</code></strong></td><td>Start jEdit without loading user-specific
    32. 

  32.                             settings.</td></tr><tr><td><strong class="userinput"><code>-startupscripts</code></strong></td><td>Run startup scripts. This is the default. Has
    33. 

  33.                             no effect when connecting to another instance via the
    34. 

  34.                             edit server. See <a class="xref" href="startup-scripts.html" title="Startup Scripts">the section called &#8220;Startup Scripts&#8221;</a>.</td></tr><tr><td><strong class="userinput"><code>-nostartupscripts</code></strong></td><td>Disable startup scripts. Has no effect when
    35. 

  35.                             connecting to another instance via the edit
    36. 

  36.                             server.</td></tr></tbody></table></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2496905"></a>Edit Server Options</h3></div></div></div><p>See <a class="xref" href="starting.html" title="Chapter 2. Starting jEdit">Chapter 2, <i>Starting jEdit</i></a> for a brief description of the
    37. 

  37.             edit server.</p><div class="informaltable"><table border="1"><colgroup><col><col></colgroup><thead><tr><th>Option</th><th>Effect</th></tr></thead><tbody><tr><td><strong class="userinput"><code>-background</code></strong></td><td>Run jEdit in background mode. In background
    38. 

  38.                             mode, the edit server will continue listening for
    39. 

  39.                             client connections even after all views are closed.
    40. 

  40.                             Has no effect when connecting to another instance via
    41. 

  41.                             the edit server.</td></tr><tr><td><strong class="userinput"><code>-nobackground</code></strong></td><td>Disable background mode. This is the default.
    42. 

  42.                             Has no effect when connecting to another instance via
    43. 

  43.                             the edit server.</td></tr><tr><td><strong class="userinput"><code>-gui</code></strong></td><td>Open an initial view. This is the default. Has
    44. 

  44.                             no effect when connecting to another instance via the
    45. 

  45.                             edit server.</td></tr><tr><td><strong class="userinput"><code>-nogui</code></strong></td><td>Do not open an initial view, and instead only
    46. 

  46.                             open one when the first client connects. Can only be
    47. 

  47.                             used in combination with the
    48. 

  48.                             <strong class="userinput"><code>-background</code></strong> switch. You can
    49. 

  49.                             use this switch to &#8220;<span class="quote">pre-load</span>&#8221; jEdit when
    50. 

  50.                             you log in to your computer, for example. Has no
    51. 

  51.                             effect when connecting to another instance via the
    52. 

  52.                             edit server.</td></tr><tr><td><strong class="userinput"><code>-newplainview</code></strong></td><td>Opens the specified files in a new plain view.
    53. 

  53.                             For more information about views, see <a class="xref" href="views.html" title="Multiple Views">the section called &#8220;Multiple Views&#8221;</a>.</td></tr><tr><td><strong class="userinput"><code>-newview</code></strong></td><td>Opens the specified files in a new
    54. 

  54.                             view.</td></tr><tr><td><strong class="userinput"><code>-reuseview</code></strong></td><td>Opens the specified files in an existing
    55. 

  55.                             view.</td></tr><tr><td><strong class="userinput"><code>-quit</code></strong></td><td>Exits the currently running editor
    56. 

  56.                             instance.</td></tr><tr><td><strong class="userinput"><code>-server</code></strong></td><td>Store the server port info in the file named
    57. 

  57.                             <code class="filename">server</code> inside the settings
    58. 

  58.                             directory.</td></tr><tr><td><strong class="userinput"><code>-server=<em class="replaceable"><code>name</code></em></code></strong></td><td>Store the server port info in the file named
    59. 

  59.                             <em class="replaceable"><code>name</code></em>. File names for this
    60. 

  60.                             parameter are relative to the settings
    61. 

  61.                             directory.</td></tr><tr><td><strong class="userinput"><code>-noserver</code></strong></td><td>Do not attempt to connect to a running edit
    62. 

  62.                             server, and do not start one either.</td></tr><tr><td><strong class="userinput"><code>-wait</code></strong></td><td>Keeps the client open until the user closes
    63. 

  63.                             the specified buffer in the server instance. Does
    64. 

  64.                             nothing if passed to the initial jEdit instance. Use
    65. 

  65.                             this switch if jEdit is being invoked by another
    66. 

  66.                             program as an external editor; otherwise the client
    67. 

  67.                             will exit immediately and the invoking program will
    68. 

  68.                             assume you have finished editing the given
    69. 

  69.                             file.</td></tr></tbody></table></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="starting.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="starting.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="basics.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. Starting jEdit </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 3. jEdit Basics</td></tr></table></div></body></html>
    70. 

  70.