SF.net SVN: geany: [1788] trunk
eht16 at users.sourceforge.net
eht16 at xxxxx
Sun Aug 12 19:30:45 UTC 2007
Revision: 1788
http://geany.svn.sourceforge.net/geany/?rev=1788&view=rev
Author: eht16
Date: 2007-08-12 12:30:45 -0700 (Sun, 12 Aug 2007)
Log Message:
-----------
Don't use output redirection since the reST tools accept output filenames.
Apply patch from John Gabriele to add some tweaks/fixes (thanks).
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/Makefile.am
trunk/doc/geany.html
trunk/doc/geany.txt
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2007-08-12 09:20:52 UTC (rev 1787)
+++ trunk/ChangeLog 2007-08-12 19:30:45 UTC (rev 1788)
@@ -3,6 +3,10 @@
* data/filetypes.freebasic: Add many keywordsGeanyObjectPrivate
(patch by Arthur Skowronek, thanks).
* geanyobject.c: Fix a runtime warning.
+ * doc/Makefile.am, doc/geany.txt, doc/geany.html:
+ Don't use output redirection since the reST tools accept output
+ filenames.
+ Apply patch from John Gabriele to add some tweaks/fixes (thanks).
2007-08-10 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
Modified: trunk/doc/Makefile.am
===================================================================
--- trunk/doc/Makefile.am 2007-08-12 09:20:52 UTC (rev 1787)
+++ trunk/doc/Makefile.am 2007-08-12 19:30:45 UTC (rev 1788)
@@ -5,13 +5,13 @@
$(srcdir)/$(IMAGE_FILES)
pdf: geany.txt
- rst2latex -stg --documentoptions="10pt,a4paper" --output-encoding=utf8 $(srcdir)/geany.txt >geany.tex
+ rst2latex -stg --documentoptions="10pt,a4paper" --output-encoding=utf8 $(srcdir)/geany.txt geany.tex
pdflatex geany.tex
rm -f geany.tex geany.aux geany.log geany.out
mv $(srcdir)/geany.pdf geany-$(VERSION).pdf
doc: geany.txt
- rst2html -stg --stylesheet=geany.css $(srcdir)/geany.txt >geany.html
+ rst2html -stg --stylesheet=geany.css $(srcdir)/geany.txt geany.html
doc-clean:
rm -f geany.html
Modified: trunk/doc/geany.html
===================================================================
--- trunk/doc/geany.html 2007-08-12 09:20:52 UTC (rev 1787)
+++ trunk/doc/geany.html 2007-08-12 19:30:45 UTC (rev 1788)
@@ -3,10 +3,10 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.4.1: http://docutils.sourceforge.net/" />
<title>Geany</title>
<meta name="authors" content="Enrico Tröger Nick Treleaven Frank Lanitz" />
-<meta name="date" content="2007-08-09" />
+<meta name="date" content="2007-08-10" />
<style type="text/css">
/*
@@ -133,7 +133,7 @@
<br />Nick Treleaven
<br />Frank Lanitz</td></tr>
<tr><th class="docinfo-name">Date:</th>
-<td>2007-08-09</td></tr>
+<td>2007-08-10</td></tr>
<tr><th class="docinfo-name">Version:</th>
<td>0.12</td></tr>
</tbody>
@@ -411,8 +411,8 @@
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
-<col width="24%" />
-<col width="63%" />
+<col width="26%" />
+<col width="61%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Short option</th>
@@ -443,9 +443,9 @@
</tr>
<tr><td>-i</td>
<td>--new-instance</td>
-<td>Do not open files in a running instance, force opening a
-new instance. Only available if Geany was compiled with
-support for Sockets.</td>
+<td>Do not open files in a running instance, force opening
+a new instance. Only available if Geany was compiled
+with support for Sockets.</td>
</tr>
<tr><td>-l</td>
<td>--line</td>
@@ -472,18 +472,18 @@
<tr><td>-t</td>
<td>--no-terminal</td>
<td>Do not load terminal support. Use this option if you do
-not want to load the virtual terminal emulator widget at
-startup. If you do not have libvte.so.4 installed, then
-terminal-support is automatically disabled. Only available
-if Geany was compiled with support for VTE.</td>
+not want to load the virtual terminal emulator widget
+at startup. If you do not have libvte.so.4 installed,
+then terminal-support is automatically disabled. Only
+available if Geany was compiled with support for VTE.</td>
</tr>
<tr><td><em>none</em></td>
<td>--vte-lib</td>
<td>Specify explicitly the path including filename or only
-the filename to the VTE library, e.g. <tt class="docutils literal"><span class="pre">/usr/lib/libvte.so</span></tt>
-or <tt class="docutils literal"><span class="pre">libvte.so</span></tt>. This option is only needed when the
-autodetection does not work. Only available if Geany was
-compiled with support for VTE.</td>
+the filename to the VTE library, e.g.
+<tt class="docutils literal"><span class="pre">/usr/lib/libvte.so</span></tt> or <tt class="docutils literal"><span class="pre">libvte.so</span></tt>. This option is
+only needed when the autodetection does not work. Only
+available if Geany was compiled with support for VTE.</td>
</tr>
<tr><td>-v</td>
<td>--version</td>
@@ -495,13 +495,14 @@
</tr>
<tr><td><em>none</em></td>
<td>[files ...]</td>
-<td>Open all given files at startup. This option causes Geany
-to ignore loading stored files from the last session (if
-enabled).</td>
+<td>Open all given files at startup. This option causes
+Geany to ignore loading stored files from the last
+session (if enabled).</td>
</tr>
</tbody>
</table>
-<p>Geany supports all generic GTK options, a list is available on the help screen.</p>
+<p>Geany supports all generic GTK options, a list is available on the
+help screen.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id14" id="general" name="general">General</a></h2>
@@ -693,8 +694,7 @@
</div>
<div class="section">
<h3><a class="toc-backref" href="#id25" id="auto-indentation" name="auto-indentation">Auto indentation</a></h3>
-<p>Geany knows three types of auto indentation: None, Basic and Advanced.</p>
-<p>Auto indentation types:</p>
+<p>Geany knows three types of auto indentation:</p>
<dl class="docutils">
<dt>None</dt>
<dd>Disables auto indentation completely.</dd>
@@ -1121,7 +1121,7 @@
appropriate <tt class="docutils literal"><span class="pre">-I/path</span></tt> include paths. The following example works with
the bash shell, generating tags for the GnomeUI library:</p>
<pre class="literal-block">
-CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \\
+CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
/usr/include/libgnomeui-2.0/gnome.h
</pre>
<p>You can adapt this command to use CFLAGS and header files appropriate
@@ -1420,8 +1420,9 @@
gtklp or similar programs can be used.</p>
<div class="note">
<p class="first admonition-title">Note</p>
-<p class="last">The printing support of Geany will be improved in the future. With GTK
-2.10, better printing (including syntax highlighting) will be possible.</p>
+<p class="last">The printing support of Geany will be improved in the future. With
+GTK 2.10, better printing (including syntax highlighting) will be
+possible.</p>
</div>
</div>
<div class="section">
@@ -1444,8 +1445,8 @@
<p>The following table lists all customizable keyboard shortcuts.</p>
<table border="1" class="docutils">
<colgroup>
-<col width="29%" />
-<col width="71%" />
+<col width="38%" />
+<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Action</th>
@@ -1454,7 +1455,7 @@
</thead>
<tbody valign="top">
<tr><td><strong>Menu items</strong></td>
-<td>...</td>
+<td> </td>
</tr>
<tr><td>New</td>
<td>Creates a new file.</td>
@@ -1556,7 +1557,7 @@
<td>Unfolds all contracted code blocks.</td>
</tr>
<tr><td><strong>Build options</strong></td>
-<td>...</td>
+<td> </td>
</tr>
<tr><td>Compile</td>
<td>Compiles the current file.</td>
@@ -1589,7 +1590,7 @@
<td>Opens the build options dialog.</td>
</tr>
<tr><td><strong>Miscellaneous</strong></td>
-<td>...</td>
+<td> </td>
</tr>
<tr><td>Reload symbol list</td>
<td>Reloads the tag/symbol list.</td>
@@ -1621,11 +1622,11 @@
history.</td>
</tr>
<tr><td>Navigate back a location</td>
-<td>Switches to the previous location in the navigation
-history.</td>
+<td>Switches to the previous location in the
+navigation history.</td>
</tr>
<tr><td><strong>Editing operations</strong></td>
-<td>...</td>
+<td> </td>
</tr>
<tr><td>Convert selection to lower case</td>
<td>Converts the current selection to lower case.</td>
@@ -1637,13 +1638,16 @@
<td>Duplicates the current line or selection.</td>
</tr>
<tr><td>Delete current line(s)</td>
-<td>Deletes the current line (and any lines with a selection).</td>
+<td>Deletes the current line (and any lines with a
+selection).</td>
</tr>
<tr><td>Cut current line(s)</td>
-<td>Cuts the current line (and any lines with a selection) to the clipboard.</td>
+<td>Cuts the current line (and any lines with a
+selection) to the clipboard.</td>
</tr>
<tr><td>Copy current line(s)</td>
-<td>Copies the current line (and any lines with a selection) to the clipboard.</td>
+<td>Copies the current line (and any lines with a
+selection) to the clipboard.</td>
</tr>
<tr><td>Transpose current line</td>
<td>Transposes the current line with the previous one.</td>
@@ -1660,32 +1664,35 @@
</tr>
<tr><td>Increase indent</td>
<td>Indents the current line or selection by one tab
-or by spaces in the amount of the tab width setting.</td>
+or by spaces in the amount of the tab width
+setting.</td>
</tr>
<tr><td>Decrease indent</td>
-<td>Removes one tabulator or the amount fo spaces of the
-tab width setting from the indentation of the current
-line or selection.</td>
+<td>Removes one tabulator or the amount fo spaces of
+the tab width setting from the indentation of the
+current line or selection.</td>
</tr>
<tr><td>Increase indent by one space</td>
-<td>Indents the current line or selection by one space.</td>
+<td>Indents the current line or selection by one
+space.</td>
</tr>
<tr><td>Decrease indent by one space</td>
-<td>Deindents the current line or selection by one space.</td>
+<td>Deindents the current line or selection by one
+space.</td>
</tr>
<tr><td>Smart line indent</td>
-<td>Indents the current line or all selected lines with
-the same intentation as the previous line.</td>
+<td>Indents the current line or all selected lines
+with the same intentation as the previous line.</td>
</tr>
<tr><td>Goto matching brace</td>
-<td>If the cursor is ahead or behind a brace, then it is
-moved to the brace which belongs to the current one.
-If this keyboard shortcut is pressed again, the cursor
-is moved back to the first brace.</td>
+<td>If the cursor is ahead or behind a brace, then it
+is moved to the brace which belongs to the current
+one. If this keyboard shortcut is pressed again,
+the cursor is moved back to the first brace.</td>
</tr>
<tr><td>Toggle marker</td>
-<td>Set a marker on the current line, or clear the marker
-if there already is one.</td>
+<td>Set a marker on the current line, or clear the
+marker if there already is one.</td>
</tr>
<tr><td>Goto next marker</td>
<td>Goto the next marker in the current document.</td>
@@ -1697,66 +1704,74 @@
<td>Shows auto completion list.</td>
</tr>
<tr><td>Show calltip</td>
-<td>Shows call tips for the current function or method.</td>
+<td>Shows call tips for the current function or
+method.</td>
</tr>
<tr><td>Show macro list</td>
-<td>Shows a list of available macros and variables in the
-workspace.</td>
+<td>Shows a list of available macros and variables in
+the workspace.</td>
</tr>
<tr><td>Complete construct</td>
-<td>If you type a construct like if or for and press this
-key, it will be completed with a matching template.</td>
+<td>If you type a construct like if or for and press
+this key, it will be completed with a matching
+template.</td>
</tr>
<tr><td>Suppress construct completion</td>
-<td>If you type a construct like if or for and press this
-key, it will not be completed, and a space or tab will
-be inserted, depending on what the construct completion
-keybinding is set to. For example, if you have set the
-construct completion keybinding to space, then setting
-this to Shift+space will prevent construct completion
-and insert a space.</td>
+<td>If you type a construct like if or for and press
+this key, it will not be completed, and a space or
+tab will be inserted, depending on what the
+construct completion keybinding is set to. For
+example, if you have set the construct completion
+keybinding to space, then setting this to
+Shift+space will prevent construct completion and
+insert a space.</td>
</tr>
<tr><td>Select current word</td>
<td>Selects the current word under the cursor.</td>
</tr>
<tr><td>Select current paragraph</td>
-<td>Selects the current paragraph under the cursor which is
-defined by two empty lines around it.</td>
+<td>Selects the current paragraph under the cursor
+which is defined by two empty lines around it.</td>
</tr>
<tr><td>Select current line(s)</td>
-<td>Selects the current line under the cursor (and any partially selected lines).</td>
+<td>Selects the current line under the cursor (and any
+partially selected lines).</td>
</tr>
<tr><td>Scroll to current line</td>
-<td>Scrolls the current line into the centre of the view.
-The cursor position and or an existing selection will not
-be changed.</td>
+<td>Scrolls the current line into the centre of the
+view. The cursor position and or an existing
+selection will not be changed.</td>
</tr>
<tr><td>Insert alternative whitespace</td>
-<td>Inserts a tabulator character when spaces should be used
-for indentation and inserts space characters of the amount
-of a tabulator width when tabulators should be used for
-indentation.</td>
+<td>Inserts a tabulator character when spaces should
+be used for indentation and inserts space
+characters of the amount of a tabulator width when
+tabulators should be used for indentation.</td>
</tr>
<tr><td>Find Usage</td>
-<td>Finds all occurrences of the current word (near the keyboard
-cursor) or selection and displays them in the messages window.</td>
+<td>Finds all occurrences of the current word (near
+the keyboard cursor) or selection and displays
+them in the messages window.</td>
</tr>
<tr><td>Go to tag definition</td>
-<td>Jump to the definition of the current word (near the keyboard
-cursor). If the definition cannot be found (e.g. the relevant
-file is not open) Geany will beep and do nothing. See the
-section called <a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</td>
+<td>Jump to the definition of the current word (near
+the keyboard cursor). If the definition cannot be
+found (e.g. the relevant file is not open) Geany
+will beep and do nothing. See the section called
+<a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</td>
</tr>
<tr><td>Go to tag declaration</td>
-<td>Jump to the declaration of the current word (near the keyboard
-cursor). If the declaration cannot be found (e.g. the relevant
-file is not open) Geany will beep and do nothing. See the section
-called <a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</td>
+<td>Jump to the declaration of the current word (near
+the keyboard cursor). If the declaration cannot be
+found (e.g. the relevant file is not open) Geany
+will beep and do nothing. See the section called
+<a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</td>
</tr>
<tr><td>Context Action</td>
-<td>Executes a command and passes the current word (near the cursor
-postion) or selection as an argument. See the section called
-<a class="reference" href="#context-actions">Context actions</a>.</td>
+<td>Executes a command and passes the current word
+(near the cursor postion) or selection as an
+argument. See the section called <a class="reference" href="#context-actions">Context
+actions</a>.</td>
</tr>
</tbody>
</table>
@@ -1779,9 +1794,9 @@
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">This feature is mainly intended for package maintainers or system
-admins who want to set up Geany in a multi user environment and set
-some sane default values for this environment. Usual users won't need
-to do that.</p>
+admins who want to set up Geany in a multi user environment and
+set some sane default values for this environment. Usual users won't
+need to do that.</p>
</div>
</div>
<div class="section">
@@ -1844,8 +1859,9 @@
<p class="last"><em>Example:</em> (look at system filetypes.* files)</p>
</dd>
<dt>comment_open</dt>
-<dd><p class="first">A character or string which is used to comment code. If you want to use
-multiline comments, also set comment_close, otherwise leave it empty.</p>
+<dd><p class="first">A character or string which is used to comment code. If you want to
+use multiline comments, also set comment_close, otherwise leave it
+empty.</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_open=/*</span></tt></p>
</dd>
<dt>comment_close</dt>
@@ -1855,31 +1871,33 @@
</dd>
<dt>comment_use_indent</dt>
<dd><p class="first">Set this to false if a comment character or string should start at
-column 0 of a line. If set to true it uses any indentation of the line.</p>
+column 0 of a line. If set to true it uses any indentation of the
+line.</p>
<p>Note: Comment indentation</p>
-<p><tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt> would generate this if a line is commented
-(e.g. with Ctrl-D):</p>
+<p><tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt> would generate this if a line is
+commented (e.g. with Ctrl-D):</p>
<pre class="literal-block">
#command_example();
</pre>
-<p><tt class="docutils literal"><span class="pre">comment_use_indent=false</span></tt> would generate this if a line is commented
-(e.g. with Ctrl-D):</p>
+<p><tt class="docutils literal"><span class="pre">comment_use_indent=false</span></tt> would generate this if a line is
+commented (e.g. with Ctrl-D):</p>
<pre class="literal-block">
# command_example();
</pre>
-<p>Note: This setting only works for single line comments (like '//', '#'
-or ';').</p>
+<p>Note: This setting only works for single line comments (like '//',
+'#' or ';').</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt></p>
</dd>
<dt>context_action_cmd</dt>
<dd><p class="first">A command which can be executed on a certain word or the current
-selection. Example usage: Open the API documentation for the current
-function call at the cursor position. The command can be set for every
-filetype or if not set, a global command will be used. The command
-itself can be specified without the full path, then it is searched
-in $PATH. But for security reasons, it is recommended to specify the
-full path to the command. The wildcard %s will be replaced by the
-current word at the cursor position or by the current selection.</p>
+selection. Example usage: Open the API documentation for the
+current function call at the cursor position. The command can
+be set for every filetype or if not set, a global command will
+be used. The command itself can be specified without the full
+path, then it is searched in $PATH. But for security reasons,
+it is recommended to specify the full path to the command. The
+wildcard %s will be replaced by the current word at the cursor
+position or by the current selection.</p>
<p>Hint: for PHP files the following could be quite useful:
context_action_cmd=firefox "<a class="reference" href="http://www.php.net/%s">http://www.php.net/%s</a>"</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">context_action_cmd=devhelp</span> <span class="pre">-s</span> <span class="pre">"%s"</span></tt></p>
@@ -1939,8 +1957,8 @@
<li>Use background colour</li>
</ul>
<p>The colours are only set if the 3rd or 4th argument is true. When
-the colours are not overridden, the default is a dark grey background
-with syntax highlighted foreground text.</p>
+the colours are not overridden, the default is a dark grey
+background with syntax highlighted foreground text.</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">selection=0xc0c0c0;0x00007F;true;true</span></tt></p>
</dd>
<dt>brace_good</dt>
@@ -1957,9 +1975,10 @@
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">caret=0x000000;0x0;false;false</span></tt></p>
</dd>
<dt>caret_width</dt>
-<dd><p class="first">The width for the caret(the blinking cursor). Only the first argument
-is interpreted. The width is specified in pixels with a maximum of
-three pixel. Use the width 0 to make the caret invisible.</p>
+<dd><p class="first">The width for the caret(the blinking cursor). Only the first
+argument is interpreted. The width is specified in pixels with
+a maximum of three pixel. Use the width 0 to make the caret
+invisible.</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">caret=1;0;false;false</span></tt></p>
</dd>
<dt>current_line</dt>
@@ -1984,7 +2003,8 @@
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">white_space=0xc0c0c0;0xffffff;true;true</span></tt></p>
</dd>
<dt>folding_style</dt>
-<dd><p class="first">The style of folding icons. Only first and second arguments are used.</p>
+<dd><p class="first">The style of folding icons. Only first and second arguments are
+used.</p>
<p>Valid values for the first argument are:</p>
<ul class="simple">
<li>1 -- for boxes</li>
@@ -2013,7 +2033,8 @@
dark background colour(e.g. black) and do not want to change every
single line. Please note, at time of writing this was only tested
with the C syntax highlighting.</p>
-<p>Only first argument is interpreted. Set it to 1 to invert all colours.</p>
+<p>Only first argument is interpreted. Set it to 1 to invert all
+colours.</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">invert_all=0;0;false;false</span></tt></p>
</dd>
<dt>whitespace_chars</dt>
@@ -2105,9 +2126,9 @@
</div>
<div class="section">
<h3><a class="toc-backref" href="#id92" id="customizing-templates" name="customizing-templates">Customizing templates</a></h3>
-<p>Each template can be customized to your needs. The templates are stored
-in the <tt class="docutils literal"><span class="pre">~/.geany/templates/</span></tt> directory (see the section called <a class="reference" href="#command-line-options">Command
-line options</a> for further information about the configuration
+<p>Each template can be customized to your needs. The templates are
+stored in the <tt class="docutils literal"><span class="pre">~/.geany/templates/</span></tt> directory (see the section called
+<a class="reference" href="#command-line-options">Command line options</a> for further information about the configuration
directory). Just open the desired template with an editor (ideally,
Geany ;-) ) and edit the template to your needs. There are some
wildcards which will be automatically replaced by Geany at startup.</p>
@@ -2116,9 +2137,9 @@
<p>All wildcards must be enclosed by "{" and "}", e.g. {date}.</p>
<table border="1" class="docutils">
<colgroup>
-<col width="10%" />
-<col width="35%" />
-<col width="55%" />
+<col width="15%" />
+<col width="48%" />
+<col width="37%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Wildcard</th>
@@ -2129,70 +2150,90 @@
<tbody valign="top">
<tr><td>developer</td>
<td>The name of the developer.</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em></td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>initial</td>
-<td>The developer's initials, e.g. "ET" for Enrico
-Tröger or "JFD" for John Foobar Doe.</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em></td>
+<td>The developer's initials, e.g. "ET" for
+Enrico Tröger or "JFD" for John Foobar Doe.</td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>mail</td>
<td>The email address of the developer.</td>
-<td><em>file header, function description, ChangeLog entry, bsd, gpl</em></td>
+<td>file header, function description,
+ChangeLog entry, bsd, gpl</td>
</tr>
<tr><td>company</td>
<td>The company the developer is working for.</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em>)</td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>year</td>
<td>The current year in the format: YYYY.</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em>)</td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>version</td>
<td>The initial version of a new file.</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em>)</td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>date</td>
<td>The current date in the format: YYYY-MM-DD.</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em>)</td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>untitled</td>
-<td>The string "untitled" (this will be translated
-to your locale), used in filetype templates.</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em>)</td>
+<td>The string "untitled" (this will be
+translated to your locale), used in
+filetype templates.</td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>geanyversion</td>
<td>The actual Geany version, e.g.
"Geany 0.12".</td>
-<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em>)</td>
+<td>filetypes, file header, function
+description, ChangeLog entry, bsd,
+gpl</td>
</tr>
<tr><td>datetime</td>
<td>The current date and time in the format:
DD.MM.YYYY HH:mm:ss ZZZZ.</td>
-<td><em>file header, function description</em></td>
+<td>file header, function description</td>
</tr>
<tr><td>filename</td>
<td>The filename of the current file.</td>
-<td><em>file header</em></td>
+<td>file header</td>
</tr>
<tr><td>gpl</td>
<td>This wildcard inserts a short GPL notice.</td>
-<td><em>file header</em></td>
+<td>file header</td>
</tr>
<tr><td>bsd</td>
<td>This wildcard inserts a BSD licence notice.</td>
-<td><em>file header</em></td>
+<td>file header</td>
</tr>
<tr><td>functionname</td>
<td>The function name of the function at the
cursor position. This wildcard will only be
-replaced in the function description template.</td>
-<td><em>function description</em></td>
+replaced in the function description
+template.</td>
+<td>function description</td>
</tr>
<tr><td>fileheader</td>
-<td>The file header template. This wildcard will
-only be replaced in filetype templates.</td>
-<td><em>filetypes</em></td>
+<td>The file header template. This wildcard
+will only be replaced in filetype
+templates.</td>
+<td>filetypes</td>
</tr>
</tbody>
</table>
@@ -2376,55 +2417,55 @@
<tr><td>GEANY_MAX_AUTOCOMPLETE_WORDS</td>
<td>How many auto completion suggestions should
Geany provide.</td>
-<td><em>30</em></td>
+<td>30</td>
</tr>
<tr><td>GEANY_MAX_AUTOCOMPLETE_HEIGHT</td>
<td>How many suggestions should be visible in
the auto completion list.</td>
-<td><em>10</em></td>
+<td>10</td>
</tr>
<tr><td>GEANY_PROJECT_EXT</td>
<td>The default filename extension for Geany
project files. It is used when creating new
projects and as filter mask for the project
open dialog.</td>
-<td><em>geany</em></td>
+<td>geany</td>
</tr>
<tr><td>GEANY_STRING_UNTITLED</td>
<td>A string used as the default name for new
files. Be aware that the string can be
translated, so change it only if you know
what you are doing.</td>
-<td><em>untitled</em></td>
+<td>untitled</td>
</tr>
<tr><td>GEANY_CHECK_FILE_DELAY</td>
<td>Time in seconds between checking a file for
external changes.</td>
-<td><em>30</em></td>
+<td>30</td>
</tr>
<tr><td>GEANY_TOGGLE_MARK</td>
<td>A string which is used to mark a toggled
comment.
external changes.</td>
-<td><em>"~ "</em></td>
+<td>"~ "</td>
</tr>
<tr><td>GEANY_WINDOW_MINIMAL_WIDTH</td>
<td>The minimal width of the main window.</td>
-<td><em>620</em></td>
+<td>620</td>
</tr>
<tr><td>GEANY_WINDOW_MINIMAL_HEIGHT</td>
<td>The minimal height of the main window.</td>
-<td><em>440</em></td>
+<td>440</td>
</tr>
<tr><td>GEANY_WINDOW_DEFAULT_WIDTH</td>
<td>The default width of the main window at the
first start.</td>
-<td><em>900</em></td>
+<td>900</td>
</tr>
<tr><td>GEANY_WINDOW_DEFAULT_HEIGHT</td>
<td>The default height of the main window at the
first start.</td>
-<td><em>600</em></td>
+<td>600</td>
</tr>
<tr><td><strong>Default values</strong></td>
<td> </td>
@@ -2432,45 +2473,45 @@
</tr>
<tr><td>GEANY_DEFAULT_TOOLS_MAKE</td>
<td>The make tool. This can also include a path.</td>
-<td><em>"make"</em></td>
+<td>"make"</td>
</tr>
<tr><td>GEANY_DEFAULT_TOOLS_TERMINAL</td>
<td>A terminal emulator. It has to accept the
command line option "-e". This can also
include a path.</td>
-<td><em>"xterm"</em></td>
+<td>"xterm"</td>
</tr>
<tr><td>GEANY_DEFAULT_TOOLS_BROWSER</td>
<td>A web browser. This can also include a path.</td>
-<td><em>"firefox"</em></td>
+<td>"firefox"</td>
</tr>
<tr><td>GEANY_DEFAULT_TOOLS_PRINTCMD</td>
<td>A printing tool. It should be able to accept
and process plain text files. This can also
include a path.</td>
-<td><em>"lpr"</em></td>
+<td>"lpr"</td>
</tr>
<tr><td>GEANY_DEFAULT_TOOLS_GREP</td>
<td>A grep tool. It should be compatible with
GNU grep. This can also include a path.</td>
-<td><em>"grep"</em></td>
+<td>"grep"</td>
</tr>
<tr><td>GEANY_DEFAULT_MRU_LENGHTH</td>
<td>The length of the "Recent files" list.</td>
-<td><em>10</em></td>
+<td>10</td>
</tr>
<tr><td>GEANY_DEFAULT_FONT_SYMBOL_LIST</td>
<td>The font used in sidebar to show symbols and
open files.</td>
-<td><em>"Sans 9"</em></td>
+<td>"Sans 9"</td>
</tr>
<tr><td>GEANY_DEFAULT_FONT_MSG_WINDOW</td>
-<td>he font used in the messages window.</td>
-<td><em>"Sans 9"</em></td>
+<td>The font used in the messages window.</td>
+<td>"Sans 9"</td>
</tr>
<tr><td>GEANY_DEFAULT_FONT_EDITOR</td>
<td>The font used in the editor window.</td>
-<td><em>"Monospace 10"</em></td>
+<td>"Monospace 10"</td>
</tr>
<tr><td><strong>Windows specific</strong></td>
<td> </td>
@@ -2484,7 +2525,7 @@
some nice features like choosing a filetype
or an encoding. <em>Do not touch this setting
when building on a non-Win32 system.</em></td>
-<td><em>0</em></td>
+<td>0</td>
</tr>
</tbody>
</table>
@@ -2855,7 +2896,7 @@
<div class="footer">
<hr class="footer" />
<a class="reference" href="geany.txt">View document source</a>.
-Generated on: 2007-08-10 11:39 UTC.
+Generated on: 2007-08-12 19:28 UTC.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
Modified: trunk/doc/geany.txt
===================================================================
--- trunk/doc/geany.txt 2007-08-12 09:20:52 UTC (rev 1787)
+++ trunk/doc/geany.txt 2007-08-12 19:30:45 UTC (rev 1788)
@@ -1,7 +1,7 @@
.. |(version)| replace:: 0.12
=======
-Geany
+ Geany
=======
-------------------------
@@ -189,9 +189,9 @@
*none* --ft-names Print a list of Geany's internal filetype names (useful
for the auto completion list).
--i --new-instance Do not open files in a running instance, force opening a
- new instance. Only available if Geany was compiled with
- support for Sockets.
+-i --new-instance Do not open files in a running instance, force opening
+ a new instance. Only available if Geany was compiled
+ with support for Sockets.
-l --line Set initial line number for the first opened file.
@@ -206,27 +206,28 @@
-s --no-session Do not load the previous session's files.
-t --no-terminal Do not load terminal support. Use this option if you do
- not want to load the virtual terminal emulator widget at
- startup. If you do not have libvte.so.4 installed, then
- terminal-support is automatically disabled. Only available
- if Geany was compiled with support for VTE.
+ not want to load the virtual terminal emulator widget
+ at startup. If you do not have libvte.so.4 installed,
+ then terminal-support is automatically disabled. Only
+ available if Geany was compiled with support for VTE.
*none* --vte-lib Specify explicitly the path including filename or only
- the filename to the VTE library, e.g. ``/usr/lib/libvte.so``
- or ``libvte.so``. This option is only needed when the
- autodetection does not work. Only available if Geany was
- compiled with support for VTE.
+ the filename to the VTE library, e.g.
+ ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
+ only needed when the autodetection does not work. Only
+ available if Geany was compiled with support for VTE.
-v --version Show version information and exit.
-? --help Show help information and exit.
-*none* [files ...] Open all given files at startup. This option causes Geany
- to ignore loading stored files from the last session (if
- enabled).
+*none* [files ...] Open all given files at startup. This option causes
+ Geany to ignore loading stored files from the last
+ session (if enabled).
============ ======================= =================================================
-Geany supports all generic GTK options, a list is available on the help screen.
+Geany supports all generic GTK options, a list is available on the
+help screen.
@@ -450,10 +451,8 @@
Auto indentation
^^^^^^^^^^^^^^^^
-Geany knows three types of auto indentation: None, Basic and Advanced.
+Geany knows three types of auto indentation:
-Auto indentation types:
-
None
Disables auto indentation completely.
Basic
@@ -926,7 +925,7 @@
appropriate ``-I/path`` include paths. The following example works with
the bash shell, generating tags for the GnomeUI library::
- CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \\
+ CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
/usr/include/libgnomeui-2.0/gnome.h
You can adapt this command to use CFLAGS and header files appropriate
@@ -1060,6 +1059,7 @@
.. image:: ./images/pref_dialog_vte.png
+
Project Management
------------------
@@ -1313,8 +1313,9 @@
gtklp or similar programs can be used.
.. note::
- The printing support of Geany will be improved in the future. With GTK
- 2.10, better printing (including syntax highlighting) will be possible.
+ The printing support of Geany will be improved in the future. With
+ GTK 2.10, better printing (including syntax highlighting) will be
+ possible.
@@ -1344,7 +1345,7 @@
=============================== =========================================
Action Description
=============================== =========================================
-**Menu items** ...
+**Menu items**
New Creates a new file.
@@ -1414,7 +1415,7 @@
Unfold all Unfolds all contracted code blocks.
-**Build options** ...
+**Build options**
Compile Compiles the current file.
@@ -1437,7 +1438,7 @@
Build options Opens the build options dialog.
-**Miscellaneous** ...
+**Miscellaneous**
Reload symbol list Reloads the tag/symbol list.
@@ -1459,10 +1460,10 @@
Navigate forward a location Switches to the next location in the navigation
history.
-Navigate back a location Switches to the previous location in the navigation
- history.
+Navigate back a location Switches to the previous location in the
+ navigation history.
-**Editing operations** ...
+**Editing operations**
Convert selection to lower case Converts the current selection to lower case.
@@ -1470,11 +1471,14 @@
Duplicate line or selection Duplicates the current line or selection.
-Delete current line(s) Deletes the current line (and any lines with a selection).
+Delete current line(s) Deletes the current line (and any lines with a
+ selection).
-Cut current line(s) Cuts the current line (and any lines with a selection) to the clipboard.
+Cut current line(s) Cuts the current line (and any lines with a
+ selection) to the clipboard.
-Copy current line(s) Copies the current line (and any lines with a selection) to the clipboard.
+Copy current line(s) Copies the current line (and any lines with a
+ selection) to the clipboard.
Transpose current line Transposes the current line with the previous one.
@@ -1486,26 +1490,29 @@
a comment if the line is commented.
Increase indent Indents the current line or selection by one tab
- or by spaces in the amount of the tab width setting.
+ or by spaces in the amount of the tab width
+ setting.
-Decrease indent Removes one tabulator or the amount fo spaces of the
- tab width setting from the indentation of the current
- line or selection.
+Decrease indent Removes one tabulator or the amount fo spaces of
+ the tab width setting from the indentation of the
+ current line or selection.
-Increase indent by one space Indents the current line or selection by one space.
+Increase indent by one space Indents the current line or selection by one
+ space.
-Decrease indent by one space Deindents the current line or selection by one space.
+Decrease indent by one space Deindents the current line or selection by one
+ space.
-Smart line indent Indents the current line or all selected lines with
- the same intentation as the previous line.
+Smart line indent Indents the current line or all selected lines
+ with the same intentation as the previous line.
-Goto matching brace If the cursor is ahead or behind a brace, then it is
- moved to the brace which belongs to the current one.
- If this keyboard shortcut is pressed again, the cursor
- is moved back to the first brace.
+Goto matching brace If the cursor is ahead or behind a brace, then it
+ is moved to the brace which belongs to the current
+ one. If this keyboard shortcut is pressed again,
+ the cursor is moved back to the first brace.
-Toggle marker Set a marker on the current line, or clear the marker
- if there already is one.
+Toggle marker Set a marker on the current line, or clear the
+ marker if there already is one.
Goto next marker Goto the next marker in the current document.
@@ -1513,54 +1520,62 @@
Complete word Shows auto completion list.
-Show calltip Shows call tips for the current function or method.
+Show calltip Shows call tips for the current function or
+ method.
-Show macro list Shows a list of available macros and variables in the
- workspace.
+Show macro list Shows a list of available macros and variables in
+ the workspace.
-Complete construct If you type a construct like if or for and press this
- key, it will be completed with a matching template.
+Complete construct If you type a construct like if or for and press
+ this key, it will be completed with a matching
+ template.
-Suppress construct completion If you type a construct like if or for and press this
- key, it will not be completed, and a space or tab will
- be inserted, depending on what the construct completion
- keybinding is set to. For example, if you have set the
- construct completion keybinding to space, then setting
- this to Shift+space will prevent construct completion
- and insert a space.
+Suppress construct completion If you type a construct like if or for and press
+ this key, it will not be completed, and a space or
+ tab will be inserted, depending on what the
+ construct completion keybinding is set to. For
+ example, if you have set the construct completion
+ keybinding to space, then setting this to
+ Shift+space will prevent construct completion and
+ insert a space.
Select current word Selects the current word under the cursor.
-Select current paragraph Selects the current paragraph under the cursor which is
- defined by two empty lines around it.
+Select current paragraph Selects the current paragraph under the cursor
+ which is defined by two empty lines around it.
-Select current line(s) Selects the current line under the cursor (and any partially selected lines).
+Select current line(s) Selects the current line under the cursor (and any
+ partially selected lines).
-Scroll to current line Scrolls the current line into the centre of the view.
- The cursor position and or an existing selection will not
- be changed.
+Scroll to current line Scrolls the current line into the centre of the
+ view. The cursor position and or an existing
+ selection will not be changed.
-Insert alternative whitespace Inserts a tabulator character when spaces should be used
- for indentation and inserts space characters of the amount
- of a tabulator width when tabulators should be used for
- indentation.
+Insert alternative whitespace Inserts a tabulator character when spaces should
+ be used for indentation and inserts space
+ characters of the amount of a tabulator width when
+ tabulators should be used for indentation.
-Find Usage Finds all occurrences of the current word (near the keyboard
- cursor) or selection and displays them in the messages window.
+Find Usage Finds all occurrences of the current word (near
+ the keyboard cursor) or selection and displays
+ them in the messages window.
-Go to tag definition Jump to the definition of the current word (near the keyboard
- cursor). If the definition cannot be found (e.g. the relevant
- file is not open) Geany will beep and do nothing. See the
- section called `Go to tag definition`_.
+Go to tag definition Jump to the definition of the current word (near
+ the keyboard cursor). If the definition cannot be
+ found (e.g. the relevant file is not open) Geany
+ will beep and do nothing. See the section called
+ `Go to tag definition`_.
-Go to tag declaration Jump to the declaration of the current word (near the keyboard
- cursor). If the declaration cannot be found (e.g. the relevant
- file is not open) Geany will beep and do nothing. See the section
- called `Go to tag definition`_.
+Go to tag declaration Jump to the declaration of the current word (near
+ the keyboard cursor). If the declaration cannot be
+ found (e.g. the relevant file is not open) Geany
+ will beep and do nothing. See the section called
+ `Go to tag definition`_.
-Context Action Executes a command and passes the current word (near the cursor
- postion) or selection as an argument. See the section called
- `Context actions`_.
+Context Action Executes a command and passes the current word
+ (near the cursor postion) or selection as an
+ argument. See the section called `Context
+ actions`_.
=============================== =========================================
@@ -1587,9 +1602,9 @@
.. note::
This feature is mainly intended for package maintainers or system
- admins who want to set up Geany in a multi user environment and set
- some sane default values for this environment. Usual users won't need
- to do that.
+ admins who want to set up Geany in a multi user environment and
+ set some sane default values for this environment. Usual users won't
+ need to do that.
@@ -1666,8 +1681,9 @@
*Example:* (look at system filetypes.\* files)
comment_open
- A character or string which is used to comment code. If you want to use
- multiline comments, also set comment_close, otherwise leave it empty.
+ A character or string which is used to comment code. If you want to
+ use multiline comments, also set comment_close, otherwise leave it
+ empty.
*Example:* ``comment_open=/*``
@@ -1679,35 +1695,37 @@
comment_use_indent
Set this to false if a comment character or string should start at
- column 0 of a line. If set to true it uses any indentation of the line.
+ column 0 of a line. If set to true it uses any indentation of the
+ line.
Note: Comment indentation
- ``comment_use_indent=true`` would generate this if a line is commented
- (e.g. with Ctrl-D)::
+ ``comment_use_indent=true`` would generate this if a line is
+ commented (e.g. with Ctrl-D)::
#command_example();
- ``comment_use_indent=false`` would generate this if a line is commented
- (e.g. with Ctrl-D)::
+ ``comment_use_indent=false`` would generate this if a line is
+ commented (e.g. with Ctrl-D)::
# command_example();
- Note: This setting only works for single line comments (like '//', '#'
- or ';').
+ Note: This setting only works for single line comments (like '//',
+ '#' or ';').
*Example:* ``comment_use_indent=true``
context_action_cmd
A command which can be executed on a certain word or the current
- selection. Example usage: Open the API documentation for the current
- function call at the cursor position. The command can be set for every
- filetype or if not set, a global command will be used. The command
- itself can be specified without the full path, then it is searched
- in $PATH. But for security reasons, it is recommended to specify the
- full path to the command. The wildcard %s will be replaced by the
- current word at the cursor position or by the current selection.
+ selection. Example usage: Open the API documentation for the
+ current function call at the cursor position. The command can
+ be set for every filetype or if not set, a global command will
+ be used. The command itself can be specified without the full
+ path, then it is searched in $PATH. But for security reasons,
+ it is recommended to specify the full path to the command. The
+ wildcard %s will be replaced by the current word at the cursor
+ position or by the current selection.
Hint: for PHP files the following could be quite useful:
context_action_cmd=firefox "http://www.php.net/%s"
@@ -1771,8 +1789,8 @@
* Use background colour
The colours are only set if the 3rd or 4th argument is true. When
- the colours are not overridden, the default is a dark grey background
- with syntax highlighted foreground text.
+ the colours are not overridden, the default is a dark grey
+ background with syntax highlighted foreground text.
*Example:* ``selection=0xc0c0c0;0x00007F;true;true``
@@ -1793,9 +1811,10 @@
*Example:* ``caret=0x000000;0x0;false;false``
caret_width
- The width for the caret(the blinking cursor). Only the first argument
- is interpreted. The width is specified in pixels with a maximum of
- three pixel. Use the width 0 to make the caret invisible.
+ The width for the caret(the blinking cursor). Only the first
+ argument is interpreted. The width is specified in pixels with
+ a maximum of three pixel. Use the width 0 to make the caret
+ invisible.
*Example:* ``caret=1;0;false;false``
@@ -1824,7 +1843,8 @@
*Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
folding_style
- The style of folding icons. Only first and second arguments are used.
+ The style of folding icons. Only first and second arguments are
+ used.
Valid values for the first argument are:
@@ -1856,7 +1876,8 @@
single line. Please note, at time of writing this was only tested
with the C syntax highlighting.
- Only first argument is interpreted. Set it to 1 to invert all colours.
+ Only first argument is interpreted. Set it to 1 to invert all
+ colours.
*Example:* ``invert_all=0;0;false;false``
@@ -1970,47 +1991,79 @@
Customizing templates
^^^^^^^^^^^^^^^^^^^^^
-Each template can be customized to your needs. The templates are stored
-in the ``~/.geany/templates/`` directory (see the section called `Command
-line options`_ for further information about the configuration
+Each template can be customized to your needs. The templates are
+stored in the ``~/.geany/templates/`` directory (see the section called
+`Command line options`_ for further information about the configuration
directory). Just open the desired template with an editor (ideally,
Geany ;-) ) and edit the template to your needs. There are some
wildcards which will be automatically replaced by Geany at startup.
+
Template wildcards
``````````````````
All wildcards must be enclosed by "{" and "}", e.g. {date}.
-============== =============================================== ==============
-Wildcard Description Available in
-============== =============================================== ==============
-developer The name of the developer. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*
-initial The developer's initials, e.g. "ET" for Enrico *filetypes, file header, function description, ChangeLog entry, bsd, gpl*
- Tröger or "JFD" for John Foobar Doe.
-mail The email address of the developer. *file header, function description, ChangeLog entry, bsd, gpl*
-company The company the developer is working for. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*)
-year The current year in the format: YYYY. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*)
-version The initial version of a new file. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*)
-date The current date in the format: YYYY-MM-DD. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*)
-untitled The string "untitled" (this will be translated *filetypes, file header, function description, ChangeLog entry, bsd, gpl*)
- to your locale), used in filetype templates.
-geanyversion The actual Geany version, e.g. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*)
- "Geany |(version)|".
-datetime The current date and time in the format: *file header, function description*
+============== ============================================= ==============
+Wildcard Description Available in
+============== ============================================= ==============
+developer The name of the developer. filetypes, file header, function
+ description, ChangeLog entry, bsd,
+ gpl
+
+initial The developer's initials, e.g. "ET" for filetypes, file header, function
+ Enrico Tröger or "JFD" for John Foobar Doe. description, ChangeLog entry, bsd,
+ gpl
+
+mail The email address of the developer. file header, function description,
+ ChangeLog entry, bsd, gpl
+
+company The company the developer is working for. filetypes, file header, function
+ description, ChangeLog entry, bsd,
+ gpl
+
+year The current year in the format: YYYY. filetypes, file header, function
+ description, ChangeLog entry, bsd,
+ gpl
+
+version The initial version of a new file. filetypes, file header, function
+ description, ChangeLog entry, bsd,
+ gpl
+
+date The current date in the format: YYYY-MM-DD. filetypes, file header, function
+ description, ChangeLog entry, bsd,
+ gpl
+
+untitled The string "untitled" (this will be filetypes, file header, function
+ translated to your locale), used in description, ChangeLog entry, bsd,
+ filetype templates. gpl
+
+geanyversion The actual Geany version, e.g. filetypes, file header, function
+ "Geany |(version)|". description, ChangeLog entry, bsd,
+ gpl
+
+datetime The current date and time in the format: file header, function description
DD.MM.YYYY HH:mm:ss ZZZZ.
-filename The filename of the current file. *file header*
-gpl This wildcard inserts a short GPL notice. *file header*
-bsd This wildcard inserts a BSD licence notice. *file header*
-functionname The function name of the function at the *function description*
+
+filename The filename of the current file. file header
+
+gpl This wildcard inserts a short GPL notice. file header
+
+bsd This wildcard inserts a BSD licence notice. file header
+
+functionname The function name of the function at the function description
cursor position. This wildcard will only be
- replaced in the function description template.
-fileheader The file header template. This wildcard will *filetypes*
- only be replaced in filetype templates.
-============== =============================================== ==============
+ replaced in the function description
+ template.
+fileheader The file header template. This wildcard filetypes
+ will only be replaced in filetype
+ templates.
+============== ============================================= ==============
+
+
Contributing to this document
=============================
@@ -2115,60 +2168,60 @@
.. note::
Most users should not need to change these options.
-============================== ============================================ =======
-Option Description Default
-============================== ============================================ =======
-GEANY_WORDCHARS These characters define word boundaries when *look at sourcecode*
- making selections and searching using word
- matching options.
-GEANY_MAX_AUTOCOMPLETE_WORDS How many auto completion suggestions should *30*
- Geany provide.
-GEANY_MAX_AUTOCOMPLETE_HEIGHT How many suggestions should be visible in *10*
- the auto completion list.
-GEANY_PROJECT_EXT The default filename extension for Geany *geany*
- project files. It is used when creating new
- projects and as filter mask for the project
- open dialog.
-GEANY_STRING_UNTITLED A string used as the default name for new *untitled*
- files. Be aware that the string can be
- translated, so change it only if you know
- what you are doing.
-GEANY_CHECK_FILE_DELAY Time in seconds between checking a file for *30*
- external changes.
-GEANY_TOGGLE_MARK A string which is used to mark a toggled *"~ "*
- comment.
- external changes.
-GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. *620*
-GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. *440*
-GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the *900*
- first start.
-GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the *600*
- first start.
+============================== ============================================ ==================
+Option Description Default
+============================== ============================================ ==================
+GEANY_WORDCHARS These characters define word boundaries when *look at sourcecode*
+ making selections and searching using word
+ matching options.
+GEANY_MAX_AUTOCOMPLETE_WORDS How many auto completion suggestions should 30
+ Geany provide.
+GEANY_MAX_AUTOCOMPLETE_HEIGHT How many suggestions should be visible in 10
+ the auto completion list.
+GEANY_PROJECT_EXT The default filename extension for Geany geany
+ project files. It is used when creating new
+ projects and as filter mask for the project
+ open dialog.
+GEANY_STRING_UNTITLED A string used as the default name for new untitled
+ files. Be aware that the string can be
+ translated, so change it only if you know
+ what you are doing.
+GEANY_CHECK_FILE_DELAY Time in seconds between checking a file for 30
+ external changes.
+GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
+ comment.
+ external changes.
+GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
+GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
+GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
+ first start.
+GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
+ first start.
**Default values**
-GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. *"make"*
-GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept the *"xterm"*
- command line option "-e". This can also
- include a path.
-GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. *"firefox"*
-GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept *"lpr"*
- and process plain text files. This can also
- include a path.
-GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with *"grep"*
- GNU grep. This can also include a path.
-GEANY_DEFAULT_MRU_LENGHTH The length of the "Recent files" list. *10*
-GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and *"Sans 9"*
- open files.
-GEANY_DEFAULT_FONT_MSG_WINDOW he font used in the messages window. *"Sans 9"*
-GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. *"Monospace 10"*
+GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
+GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept the "xterm"
+ command line option "-e". This can also
+ include a path.
+GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
+GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
+ and process plain text files. This can also
+ include a path.
+GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
+ GNU grep. This can also include a path.
+GEANY_DEFAULT_MRU_LENGHTH The length of the "Recent files" list. 10
+GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
+ open files.
+GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
+GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
**Windows specific**
-GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default *0*
- Windows file open and save dialogs instead
- GTK's file open and save dialogs. The
- default Windows file dialogs are missing
- some nice features like choosing a filetype
- or an encoding. *Do not touch this setting
- when building on a non-Win32 system.*
-============================== ============================================ =======
+GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
+ Windows file open and save dialogs instead
+ GTK's file open and save dialogs. The
+ default Windows file dialogs are missing
+ some nice features like choosing a filetype
+ or an encoding. *Do not touch this setting
+ when building on a non-Win32 system.*
+============================== ============================================ ==================
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Commits
mailing list