PageRenderTime 54ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/users-guide/settings-directory.html

#
HTML | 53 lines | 53 code | 0 blank | 0 comment | 0 complexity | 10a45c0d7030586fa6335f586aa2d174 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>The jEdit Settings Directory</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="customizing.html" title="Chapter 7. Customizing jEdit"><link rel="prev" href="global-opts.html" title="The Global Options Dialog Box"><link rel="next" href="using-macros.html" title="Chapter 8. Using Macros"></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">The jEdit Settings Directory</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="global-opts.html">Prev</a> </td><th width="60%" align="center">Chapter 7. Customizing jEdit</th><td width="20%" align="right"> <a accesskey="n" href="using-macros.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="settings-directory"></a>The jEdit Settings Directory</h2></div></div></div><p>jEdit stores settings, macros, and plugins as files inside the
    2. 

  2.         <em class="firstterm">settings directory</em>. In most cases, editing these
    3. 

  3.         files by hand is not necessary, since graphical tools and editor
    4. 

  4.         commands can do the job. However, being familiar with the structure of
    5. 

  5.         the settings directory still comes in handy in certain situations, for
    6. 

  6.         example when you want to copy jEdit settings between computers.</p><p>The location of the settings directory is system-specific; it is
    7. 

  7.         printed to the activity log
    8. 

  8.         (<span class="guimenu"><strong>Utilities</strong></span>&gt;<span class="guisubmenu"><strong>Troubleshooting</strong></span>&gt;<span class="guimenuitem"><strong>Activity
    9. 

  9.         Log</strong></span>). For example:</p><pre class="screen">[message] jEdit: Settings directory is /home/slava/.jedit</pre><p>Specifying the <strong class="userinput"><code>-settings</code></strong> switch on the
    10. 

  10.         command line instructs jEdit to store settings in a directory other than
    11. 

  11.         the default. For example, the following command will instruct jEdit to
    12. 

  12.         store all settings in the <code class="filename">jedit</code> subdirectory of the
    13. 

  13.         <code class="filename">C:</code> drive:</p><pre class="screen"><code class="prompt">C:\jedit&gt;</code> <strong class="userinput"><code>jedit -settings=C:\jedit</code></strong></pre><p>The <strong class="userinput"><code>-nosettings</code></strong> switch will force jEdit to
    14. 

  14.         not look for or create a settings directory; default settings will be
    15. 

  15.         used instead.</p><p>jEdit creates the following files and directories inside the
    16. 

  16.         settings directory; plugins may add more:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="filename">abbrevs</code> - a plain text file which
    17. 

  17.                 stores all defined abbreviations. See <a class="xref" href="abbrevs.html" title="Abbreviations">the section called &#8220;Abbreviations&#8221;</a>.</p></li><li><p><code class="filename">activity.log</code> - a plain text file
    18. 

  18.                 which contains the full activity log. See <a class="xref" href="activity-log.html" title="Appendix B. The Activity Log">Appendix B, <i>The Activity Log</i></a>.</p></li><li><p><code class="filename">history</code> - a plain text file which
    19. 

  19.                 stores history lists, used by history text fields and the
    20. 

  20.                 <span class="guimenu"><strong>Edit</strong></span>&gt;<span class="guimenuitem"><strong>Paste
    21. 

  21.                 Previous</strong></span> command. See <a class="xref" href="text-transfer.html" title="Transferring Text">the section called &#8220;Transferring Text&#8221;</a> and <a class="xref" href="history.html" title="Appendix C. History Text Fields">Appendix C, <i>History Text Fields</i></a>.</p></li><li><p><code class="filename">jars</code> - this directory contains
    22. 

  22.                 plugins. See <a class="xref" href="using-plugins.html" title="Chapter 9. Installing and Using Plugins">Chapter 9, <i>Installing and Using Plugins</i></a>.</p></li><li><p><code class="filename">jars-cache</code> - this directory contains
    23. 

  23.                 plugin cache files which decrease the time to start jEdit. They
    24. 

  24.                 are automatically updated when plugins are installed or
    25. 

  25.                 updated.</p></li><li><p><code class="filename">killring.xml</code> - stores recently
    26. 

  26.                 deleted text. See <a class="xref" href="text-transfer.html" title="Transferring Text">the section called &#8220;Transferring Text&#8221;</a>.</p></li><li><p><code class="filename">macros</code> - this directory contains
    27. 

  27.                 macros. See <a class="xref" href="using-macros.html" title="Chapter 8. Using Macros">Chapter 8, <i>Using Macros</i></a>.</p></li><li><p><code class="filename">modes</code> - this directory contains
    28. 

  28.                 custom edit modes. See <a class="xref" href="writing-modes-part.html" title="Part II. Writing Edit Modes">Part II, &#8220;Writing Edit Modes&#8221;</a>.</p></li><li><p><code class="filename">perspective.xml</code> - an XML file that
    29. 

  29.                 stores the list of open buffers and views used to maintain
    30. 

  30.                 editor state between sessions.</p></li><li><p><code class="filename">PluginManager.download</code> - this
    31. 

  31.                 directory is usually empty. It only contains files while the
    32. 

  32.                 plugin manager is downloading a plugin. For information about
    33. 

  33.                 the plugin manager, see <a class="xref" href="using-plugins.html" title="Chapter 9. Installing and Using Plugins">Chapter 9, <i>Installing and Using Plugins</i></a>.</p></li><li><p>
    34. 

  34.               <code class="filename">pluginMgr-Cached.xml.gz</code> - 
    35. 

  35.                 this contains a cached copy of the last XML plugin list downloaded from plugin central. If you delete this file, a new one will be created next time you try to install a plugin via Plugin Manager. </p></li><li><p><code class="filename">printspec</code> - a binary file that stores
    36. 

  36.                 printing settings when running under Java 2 version 1.4.</p></li><li><p><code class="filename">properties</code> - a plain text file that
    37. 

  37.                 stores the majority of jEdit's and its plugins settings. For
    38. 

  38.                 more information see <a class="xref" href="settings-directory.html#propertiesfile" title="The jEdit properties file">the section called &#8220;The jEdit properties file&#8221;</a>.</p></li><li><p><code class="filename">recent.xml</code> - an XML file which stores
    39. 

  39.                 the list of recently opened files. jEdit remembers the caret
    40. 

  40.                 position and character encoding of each recent file, and
    41. 

  41.                 automatically restores those values when one of the files is
    42. 

  42.                 opened.</p></li><li><p><code class="filename">registers.xml</code> - an XML file that
    43. 

  43.                 stores register contents. See <a class="xref" href="text-transfer.html#registers" title="General Register Commands">the section called &#8220;General Register Commands&#8221;</a> for
    44. 

  44.                 more information about registers.</p></li><li><p><code class="filename">server</code> - a plain text file that only
    45. 

  45.                 exists while jEdit is running. The edit server's port number and
    46. 

  46.                 authorization key is stored here. See <a class="xref" href="starting.html" title="Chapter 2. Starting jEdit">Chapter 2, <i>Starting jEdit</i></a>.</p></li><li><p><code class="filename">settings-backup</code> - this directory
    47. 

  47.                 contains numbered backups of all automatically-written settings
    48. 

  48.                 files.</p></li></ul></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="propertiesfile"></a>The jEdit properties file</h3></div></div></div><p>The jEdit <code class="literal">properties</code> file uses the Java
    49. 

  49.             properties syntax to store key/value pairs. All of the values are
    50. 

  50.             stored as strings, but are interpreted as other types (such as
    51. 

  51.             integer or boolean) by plugins at runtime.</p><p>Editing and saving this file while jEdit is running means that
    52. 

  52.             until you restart jEdit again, all other changed settings will be
    53. 

  53.             lost.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="global-opts.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="customizing.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="using-macros.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The Global Options Dialog Box </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 8. Using Macros</td></tr></table></div></body></html>
    54. 

  54.