HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Don't use output redirection since the reST tools accept output filenames.

Browse Source 
Apply patch from John Gabriele to add some tweaks/fixes (thanks).


git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1788 ea778897-0a13-0410-b9d1-a72fbfd435f5
This commit is contained in:
Enrico Tröger 2007-08-12 19:30:45 +00:00
parent 1077a80c0d
commit 61a42e108f
4 changed files with 446 additions and 348 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -3,6 +3,10 @@
* data/filetypes.freebasic: Add many keywordsGeanyObjectPrivate * data/filetypes.freebasic: Add many keywordsGeanyObjectPrivate
(patch by Arthur Skowronek, thanks). (patch by Arthur Skowronek, thanks).
* geanyobject.c: Fix a runtime warning. * 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> 2007-08-10 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>

4
doc/Makefile.am
View File

@ -5,13 +5,13 @@ EXTRA_DIST = geany.html geany.css geany.txt geany.1 \
$(srcdir)/$(IMAGE_FILES) $(srcdir)/$(IMAGE_FILES)
pdf: geany.txt 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 pdflatex geany.tex
rm -f geany.tex geany.aux geany.log geany.out rm -f geany.tex geany.aux geany.log geany.out
mv $(srcdir)/geany.pdf geany-$(VERSION).pdf mv $(srcdir)/geany.pdf geany-$(VERSION).pdf
doc: geany.txt 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: doc-clean:
rm -f geany.html rm -f geany.html

363
doc/geany.html
View File

@ -3,10 +3,10 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <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> <title>Geany</title>
<meta name="authors" content="Enrico Tröger Nick Treleaven Frank Lanitz" /> <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"> <style type="text/css">
/* /*
@ -133,7 +133,7 @@ dt {
<br />Nick Treleaven <br />Nick Treleaven
<br />Frank Lanitz</td></tr> <br />Frank Lanitz</td></tr>
<tr><th class="docinfo-name">Date:</th> <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> <tr><th class="docinfo-name">Version:</th>
<td>0.12</td></tr> <td>0.12</td></tr>
</tbody> </tbody>
@ -411,8 +411,8 @@ Return:</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
<col width="13%" /> <col width="13%" />
<col width="24%" /> <col width="26%" />
<col width="63%" /> <col width="61%" />
</colgroup> </colgroup>
<thead valign="bottom"> <thead valign="bottom">
<tr><th class="head">Short option</th> <tr><th class="head">Short option</th>
@ -443,9 +443,9 @@ for the auto completion list).</td>
</tr> </tr>
<tr><td>-i</td> <tr><td>-i</td>
<td>--new-instance</td> <td>--new-instance</td>
<td>Do not open files in a running instance, force opening a <td>Do not open files in a running instance, force opening
new instance. Only available if Geany was compiled with a new instance. Only available if Geany was compiled
support for Sockets.</td> with support for Sockets.</td>
</tr> </tr>
<tr><td>-l</td> <tr><td>-l</td>
<td>--line</td> <td>--line</td>
@ -472,18 +472,18 @@ option if you do not want to use them.</td>
<tr><td>-t</td> <tr><td>-t</td>
<td>--no-terminal</td> <td>--no-terminal</td>
<td>Do not load terminal support. Use this option if you do <td>Do not load terminal support. Use this option if you do
not want to load the virtual terminal emulator widget at not want to load the virtual terminal emulator widget
startup. If you do not have libvte.so.4 installed, then at startup. If you do not have libvte.so.4 installed,
terminal-support is automatically disabled. Only available then terminal-support is automatically disabled. Only
if Geany was compiled with support for VTE.</td> available if Geany was compiled with support for VTE.</td>
</tr> </tr>
<tr><td><em>none</em></td> <tr><td><em>none</em></td>
<td>--vte-lib</td> <td>--vte-lib</td>
<td>Specify explicitly the path including filename or only <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> the filename to the VTE library, e.g.
or <tt class="docutils literal"><span class="pre">libvte.so</span></tt>. This option is only needed when the <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
autodetection does not work. Only available if Geany was only needed when the autodetection does not work. Only
compiled with support for VTE.</td> available if Geany was compiled with support for VTE.</td>
</tr> </tr>
<tr><td>-v</td> <tr><td>-v</td>
<td>--version</td> <td>--version</td>
@ -495,13 +495,14 @@ compiled with support for VTE.</td>
</tr> </tr>
<tr><td><em>none</em></td> <tr><td><em>none</em></td>
<td>[files ...]</td> <td>[files ...]</td>
<td>Open all given files at startup. This option causes Geany <td>Open all given files at startup. This option causes
to ignore loading stored files from the last session (if Geany to ignore loading stored files from the last
enabled).</td> session (if enabled).</td>
</tr> </tr>
</tbody> </tbody>
</table> </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>
<div class="section"> <div class="section">
<h2><a class="toc-backref" href="#id14" id="general" name="general">General</a></h2> <h2><a class="toc-backref" href="#id14" id="general" name="general">General</a></h2>
@ -693,8 +694,7 @@ before the selected text was copied to the new position.</p>
</div> </div>
<div class="section"> <div class="section">
<h3><a class="toc-backref" href="#id25" id="auto-indentation" name="auto-indentation">Auto indentation</a></h3> <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>Geany knows three types of auto indentation:</p>
<p>Auto indentation types:</p>
<dl class="docutils"> <dl class="docutils">
<dt>None</dt> <dt>None</dt>
<dd>Disables auto indentation completely.</dd> <dd>Disables auto indentation completely.</dd>
@ -1121,7 +1121,7 @@ can be preprocessed to include any other headers they depend upon.</p>
appropriate <tt class="docutils literal"><span class="pre">-I/path</span></tt> include paths. The following example works with 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> the bash shell, generating tags for the GnomeUI library:</p>
<pre class="literal-block"> <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 /usr/include/libgnomeui-2.0/gnome.h
</pre> </pre>
<p>You can adapt this command to use CFLAGS and header files appropriate <p>You can adapt this command to use CFLAGS and header files appropriate
@ -1420,8 +1420,9 @@ command line).</p>
gtklp or similar programs can be used.</p> gtklp or similar programs can be used.</p>
<div class="note"> <div class="note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">The printing support of Geany will be improved in the future. With GTK <p class="last">The printing support of Geany will be improved in the future. With
2.10, better printing (including syntax highlighting) will be possible.</p> GTK 2.10, better printing (including syntax highlighting) will be
possible.</p>
</div> </div>
</div> </div>
<div class="section"> <div class="section">
@ -1444,8 +1445,8 @@ or Alt-O.</p>
<p>The following table lists all customizable keyboard shortcuts.</p> <p>The following table lists all customizable keyboard shortcuts.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
<col width="29%" /> <col width="38%" />
<col width="71%" /> <col width="62%" />
</colgroup> </colgroup>
<thead valign="bottom"> <thead valign="bottom">
<tr><th class="head">Action</th> <tr><th class="head">Action</th>
@ -1454,7 +1455,7 @@ or Alt-O.</p>
</thead> </thead>
<tbody valign="top"> <tbody valign="top">
<tr><td><strong>Menu items</strong></td> <tr><td><strong>Menu items</strong></td>
<td>...</td> <td>&nbsp;</td>
</tr> </tr>
<tr><td>New</td> <tr><td>New</td>
<td>Creates a new file.</td> <td>Creates a new file.</td>
@ -1556,7 +1557,7 @@ and the statusbar.</td>
<td>Unfolds all contracted code blocks.</td> <td>Unfolds all contracted code blocks.</td>
</tr> </tr>
<tr><td><strong>Build options</strong></td> <tr><td><strong>Build options</strong></td>
<td>...</td> <td>&nbsp;</td>
</tr> </tr>
<tr><td>Compile</td> <tr><td>Compile</td>
<td>Compiles the current file.</td> <td>Compiles the current file.</td>
@ -1589,7 +1590,7 @@ last build process.</td>
<td>Opens the build options dialog.</td> <td>Opens the build options dialog.</td>
</tr> </tr>
<tr><td><strong>Miscellaneous</strong></td> <tr><td><strong>Miscellaneous</strong></td>
<td>...</td> <td>&nbsp;</td>
</tr> </tr>
<tr><td>Reload symbol list</td> <tr><td>Reload symbol list</td>
<td>Reloads the tag/symbol list.</td> <td>Reloads the tag/symbol list.</td>
@ -1621,11 +1622,11 @@ visible).</td>
history.</td> history.</td>
</tr> </tr>
<tr><td>Navigate back a location</td> <tr><td>Navigate back a location</td>
<td>Switches to the previous location in the navigation <td>Switches to the previous location in the
history.</td> navigation history.</td>
</tr> </tr>
<tr><td><strong>Editing operations</strong></td> <tr><td><strong>Editing operations</strong></td>
<td>...</td> <td>&nbsp;</td>
</tr> </tr>
<tr><td>Convert selection to lower case</td> <tr><td>Convert selection to lower case</td>
<td>Converts the current selection to lower case.</td> <td>Converts the current selection to lower case.</td>
@ -1637,13 +1638,16 @@ history.</td>
<td>Duplicates the current line or selection.</td> <td>Duplicates the current line or selection.</td>
</tr> </tr>
<tr><td>Delete current line(s)</td> <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>
<tr><td>Cut current line(s)</td> <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>
<tr><td>Copy current line(s)</td> <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>
<tr><td>Transpose current line</td> <tr><td>Transpose current line</td>
<td>Transposes the current line with the previous one.</td> <td>Transposes the current line with the previous one.</td>
@ -1660,32 +1664,35 @@ a comment if the line is commented.</td>
</tr> </tr>
<tr><td>Increase indent</td> <tr><td>Increase indent</td>
<td>Indents the current line or selection by one tab <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>
<tr><td>Decrease indent</td> <tr><td>Decrease indent</td>
<td>Removes one tabulator or the amount fo spaces of the <td>Removes one tabulator or the amount fo spaces of
tab width setting from the indentation of the current the tab width setting from the indentation of the
line or selection.</td> current line or selection.</td>
</tr> </tr>
<tr><td>Increase indent by one space</td> <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>
<tr><td>Decrease indent by one space</td> <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>
<tr><td>Smart line indent</td> <tr><td>Smart line indent</td>
<td>Indents the current line or all selected lines with <td>Indents the current line or all selected lines
the same intentation as the previous line.</td> with the same intentation as the previous line.</td>
</tr> </tr>
<tr><td>Goto matching brace</td> <tr><td>Goto matching brace</td>
<td>If the cursor is ahead or behind a brace, then it is <td>If the cursor is ahead or behind a brace, then it
moved to the brace which belongs to the current one. is moved to the brace which belongs to the current
If this keyboard shortcut is pressed again, the cursor one. If this keyboard shortcut is pressed again,
is moved back to the first brace.</td> the cursor is moved back to the first brace.</td>
</tr> </tr>
<tr><td>Toggle marker</td> <tr><td>Toggle marker</td>
<td>Set a marker on the current line, or clear the marker <td>Set a marker on the current line, or clear the
if there already is one.</td> marker if there already is one.</td>
</tr> </tr>
<tr><td>Goto next marker</td> <tr><td>Goto next marker</td>
<td>Goto the next marker in the current document.</td> <td>Goto the next marker in the current document.</td>
@ -1697,66 +1704,74 @@ if there already is one.</td>
<td>Shows auto completion list.</td> <td>Shows auto completion list.</td>
</tr> </tr>
<tr><td>Show calltip</td> <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>
<tr><td>Show macro list</td> <tr><td>Show macro list</td>
<td>Shows a list of available macros and variables in the <td>Shows a list of available macros and variables in
workspace.</td> the workspace.</td>
</tr> </tr>
<tr><td>Complete construct</td> <tr><td>Complete construct</td>
<td>If you type a construct like if or for and press this <td>If you type a construct like if or for and press
key, it will be completed with a matching template.</td> this key, it will be completed with a matching
template.</td>
</tr> </tr>
<tr><td>Suppress construct completion</td> <tr><td>Suppress construct completion</td>
<td>If you type a construct like if or for and press this <td>If you type a construct like if or for and press
key, it will not be completed, and a space or tab will this key, it will not be completed, and a space or
be inserted, depending on what the construct completion tab will be inserted, depending on what the
keybinding is set to. For example, if you have set the construct completion keybinding is set to. For
construct completion keybinding to space, then setting example, if you have set the construct completion
this to Shift+space will prevent construct completion keybinding to space, then setting this to
and insert a space.</td> Shift+space will prevent construct completion and
insert a space.</td>
</tr> </tr>
<tr><td>Select current word</td> <tr><td>Select current word</td>
<td>Selects the current word under the cursor.</td> <td>Selects the current word under the cursor.</td>
</tr> </tr>
<tr><td>Select current paragraph</td> <tr><td>Select current paragraph</td>
<td>Selects the current paragraph under the cursor which is <td>Selects the current paragraph under the cursor
defined by two empty lines around it.</td> which is defined by two empty lines around it.</td>
</tr> </tr>
<tr><td>Select current line(s)</td> <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>
<tr><td>Scroll to current line</td> <tr><td>Scroll to current line</td>
<td>Scrolls the current line into the centre of the view. <td>Scrolls the current line into the centre of the
The cursor position and or an existing selection will not view. The cursor position and or an existing
be changed.</td> selection will not be changed.</td>
</tr> </tr>
<tr><td>Insert alternative whitespace</td> <tr><td>Insert alternative whitespace</td>
<td>Inserts a tabulator character when spaces should be used <td>Inserts a tabulator character when spaces should
for indentation and inserts space characters of the amount be used for indentation and inserts space
of a tabulator width when tabulators should be used for characters of the amount of a tabulator width when
indentation.</td> tabulators should be used for indentation.</td>
</tr> </tr>
<tr><td>Find Usage</td> <tr><td>Find Usage</td>
<td>Finds all occurrences of the current word (near the keyboard <td>Finds all occurrences of the current word (near
cursor) or selection and displays them in the messages window.</td> the keyboard cursor) or selection and displays
them in the messages window.</td>
</tr> </tr>
<tr><td>Go to tag definition</td> <tr><td>Go to tag definition</td>
<td>Jump to the definition of the current word (near the keyboard <td>Jump to the definition of the current word (near
cursor). If the definition cannot be found (e.g. the relevant the keyboard cursor). If the definition cannot be
file is not open) Geany will beep and do nothing. See the found (e.g. the relevant file is not open) Geany
section called <a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</td> 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>
<tr><td>Go to tag declaration</td> <tr><td>Go to tag declaration</td>
<td>Jump to the declaration of the current word (near the keyboard <td>Jump to the declaration of the current word (near
cursor). If the declaration cannot be found (e.g. the relevant the keyboard cursor). If the declaration cannot be
file is not open) Geany will beep and do nothing. See the section found (e.g. the relevant file is not open) Geany
called <a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</td> 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>
<tr><td>Context Action</td> <tr><td>Context Action</td>
<td>Executes a command and passes the current word (near the cursor <td>Executes a command and passes the current word
postion) or selection as an argument. See the section called (near the cursor postion) or selection as an
<a class="reference" href="#context-actions">Context actions</a>.</td> argument. See the section called <a class="reference" href="#context-actions">Context
actions</a>.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -1779,9 +1794,9 @@ contain all settings.</p>
<div class="note"> <div class="note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">This feature is mainly intended for package maintainers or system <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 admins who want to set up Geany in a multi user environment and
some sane default values for this environment. Usual users won't need set some sane default values for this environment. Usual users won't
to do that.</p> need to do that.</p>
</div> </div>
</div> </div>
<div class="section"> <div class="section">
@ -1844,8 +1859,9 @@ and searching using word matching options.</p>
<p class="last"><em>Example:</em> (look at system filetypes.* files)</p> <p class="last"><em>Example:</em> (look at system filetypes.* files)</p>
</dd> </dd>
<dt>comment_open</dt> <dt>comment_open</dt>
<dd><p class="first">A character or string which is used to comment code. If you want to use <dd><p class="first">A character or string which is used to comment code. If you want to
multiline comments, also set comment_close, otherwise leave it empty.</p> 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> <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_open=/*</span></tt></p>
</dd> </dd>
<dt>comment_close</dt> <dt>comment_close</dt>
@ -1855,31 +1871,33 @@ close the comment.</p>
</dd> </dd>
<dt>comment_use_indent</dt> <dt>comment_use_indent</dt>
<dd><p class="first">Set this to false if a comment character or string should start at <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>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 <p><tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt> would generate this if a line is
(e.g. with Ctrl-D):</p> commented (e.g. with Ctrl-D):</p>
<pre class="literal-block"> <pre class="literal-block">
#command_example(); #command_example();
</pre> </pre>
<p><tt class="docutils literal"><span class="pre">comment_use_indent=false</span></tt> would generate this if a line is commented <p><tt class="docutils literal"><span class="pre">comment_use_indent=false</span></tt> would generate this if a line is
(e.g. with Ctrl-D):</p> commented (e.g. with Ctrl-D):</p>
<pre class="literal-block"> <pre class="literal-block">
# command_example(); # command_example();
</pre> </pre>
<p>Note: This setting only works for single line comments (like '//', '#' <p>Note: This setting only works for single line comments (like '//',
or ';').</p> '#' or ';').</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt></p> <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt></p>
</dd> </dd>
<dt>context_action_cmd</dt> <dt>context_action_cmd</dt>
<dd><p class="first">A command which can be executed on a certain word or the current <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 selection. Example usage: Open the API documentation for the
function call at the cursor position. The command can be set for every current function call at the cursor position. The command can
filetype or if not set, a global command will be used. The command be set for every filetype or if not set, a global command will
itself can be specified without the full path, then it is searched be used. The command itself can be specified without the full
in $PATH. But for security reasons, it is recommended to specify the path, then it is searched in $PATH. But for security reasons,
full path to the command. The wildcard %s will be replaced by the it is recommended to specify the full path to the command. The
current word at the cursor position or by the current selection.</p> 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: <p>Hint: for PHP files the following could be quite useful:
context_action_cmd=firefox &quot;<a class="reference" href="http://www.php.net/%s">http://www.php.net/%s</a>&quot;</p> context_action_cmd=firefox &quot;<a class="reference" href="http://www.php.net/%s">http://www.php.net/%s</a>&quot;</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">&quot;%s&quot;</span></tt></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">&quot;%s&quot;</span></tt></p>
@ -1939,8 +1957,8 @@ filetype set.</p>
<li>Use background colour</li> <li>Use background colour</li>
</ul> </ul>
<p>The colours are only set if the 3rd or 4th argument is true. When <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 the colours are not overridden, the default is a dark grey
with syntax highlighted foreground text.</p> 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> <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">selection=0xc0c0c0;0x00007F;true;true</span></tt></p>
</dd> </dd>
<dt>brace_good</dt> <dt>brace_good</dt>
@ -1957,9 +1975,10 @@ first argument is interpreted.</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">caret=0x000000;0x0;false;false</span></tt></p> <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">caret=0x000000;0x0;false;false</span></tt></p>
</dd> </dd>
<dt>caret_width</dt> <dt>caret_width</dt>
<dd><p class="first">The width for the caret(the blinking cursor). Only the first argument <dd><p class="first">The width for the caret(the blinking cursor). Only the first
is interpreted. The width is specified in pixels with a maximum of argument is interpreted. The width is specified in pixels with
three pixel. Use the width 0 to make the caret invisible.</p> 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> <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">caret=1;0;false;false</span></tt></p>
</dd> </dd>
<dt>current_line</dt> <dt>current_line</dt>
@ -1984,7 +2003,8 @@ The fourth argument defines whether to use the background colour.</p>
<p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">white_space=0xc0c0c0;0xffffff;true;true</span></tt></p> <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">white_space=0xc0c0c0;0xffffff;true;true</span></tt></p>
</dd> </dd>
<dt>folding_style</dt> <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> <p>Valid values for the first argument are:</p>
<ul class="simple"> <ul class="simple">
<li>1 -- for boxes</li> <li>1 -- for boxes</li>
@ -2013,7 +2033,8 @@ first argument is used.</p>
dark background colour(e.g. black) and do not want to change every 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 single line. Please note, at time of writing this was only tested
with the C syntax highlighting.</p> 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> <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">invert_all=0;0;false;false</span></tt></p>
</dd> </dd>
<dt>whitespace_chars</dt> <dt>whitespace_chars</dt>
@ -2105,9 +2126,9 @@ the New command is used without a filetype. This is empty by default.</p>
</div> </div>
<div class="section"> <div class="section">
<h3><a class="toc-backref" href="#id92" id="customizing-templates" name="customizing-templates">Customizing templates</a></h3> <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 <p>Each template can be customized to your needs. The templates are
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 stored in the <tt class="docutils literal"><span class="pre">~/.geany/templates/</span></tt> directory (see the section called
line options</a> for further information about the configuration <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, directory). Just open the desired template with an editor (ideally,
Geany ;-) ) and edit the template to your needs. There are some Geany ;-) ) and edit the template to your needs. There are some
wildcards which will be automatically replaced by Geany at startup.</p> wildcards which will be automatically replaced by Geany at startup.</p>
@ -2116,9 +2137,9 @@ wildcards which will be automatically replaced by Geany at startup.</p>
<p>All wildcards must be enclosed by &quot;{&quot; and &quot;}&quot;, e.g. {date}.</p> <p>All wildcards must be enclosed by &quot;{&quot; and &quot;}&quot;, e.g. {date}.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
<col width="10%" /> <col width="15%" />
<col width="35%" /> <col width="48%" />
<col width="55%" /> <col width="37%" />
</colgroup> </colgroup>
<thead valign="bottom"> <thead valign="bottom">
<tr><th class="head">Wildcard</th> <tr><th class="head">Wildcard</th>
@ -2129,70 +2150,90 @@ wildcards which will be automatically replaced by Geany at startup.</p>
<tbody valign="top"> <tbody valign="top">
<tr><td>developer</td> <tr><td>developer</td>
<td>The name of the 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>
<tr><td>initial</td> <tr><td>initial</td>
<td>The developer's initials, e.g. &quot;ET&quot; for Enrico <td>The developer's initials, e.g. &quot;ET&quot; for
Tröger or &quot;JFD&quot; for John Foobar Doe.</td> Enrico Tröger or &quot;JFD&quot; for John Foobar Doe.</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>
<tr><td>mail</td> <tr><td>mail</td>
<td>The email address of the developer.</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>
<tr><td>company</td> <tr><td>company</td>
<td>The company the developer is working for.</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>
<tr><td>year</td> <tr><td>year</td>
<td>The current year in the format: YYYY.</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>
<tr><td>version</td> <tr><td>version</td>
<td>The initial version of a new file.</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>
<tr><td>date</td> <tr><td>date</td>
<td>The current date in the format: YYYY-MM-DD.</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>
<tr><td>untitled</td> <tr><td>untitled</td>
<td>The string &quot;untitled&quot; (this will be translated <td>The string &quot;untitled&quot; (this will be
to your locale), used in filetype templates.</td> translated to your locale), used in
<td><em>filetypes, file header, function description, ChangeLog entry, bsd, gpl</em>)</td> filetype templates.</td>
<td>filetypes, file header, function
description, ChangeLog entry, bsd,
gpl</td>
</tr> </tr>
<tr><td>geanyversion</td> <tr><td>geanyversion</td>
<td>The actual Geany version, e.g. <td>The actual Geany version, e.g.
&quot;Geany 0.12&quot;.</td> &quot;Geany 0.12&quot;.</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>
<tr><td>datetime</td> <tr><td>datetime</td>
<td>The current date and time in the format: <td>The current date and time in the format:
DD.MM.YYYY HH:mm:ss ZZZZ.</td> DD.MM.YYYY HH:mm:ss ZZZZ.</td>
<td><em>file header, function description</em></td> <td>file header, function description</td>
</tr> </tr>
<tr><td>filename</td> <tr><td>filename</td>
<td>The filename of the current file.</td> <td>The filename of the current file.</td>
<td><em>file header</em></td> <td>file header</td>
</tr> </tr>
<tr><td>gpl</td> <tr><td>gpl</td>
<td>This wildcard inserts a short GPL notice.</td> <td>This wildcard inserts a short GPL notice.</td>
<td><em>file header</em></td> <td>file header</td>
</tr> </tr>
<tr><td>bsd</td> <tr><td>bsd</td>
<td>This wildcard inserts a BSD licence notice.</td> <td>This wildcard inserts a BSD licence notice.</td>
<td><em>file header</em></td> <td>file header</td>
</tr> </tr>
<tr><td>functionname</td> <tr><td>functionname</td>
<td>The function name of the function at the <td>The function name of the function at the
cursor position. This wildcard will only be cursor position. This wildcard will only be
replaced in the function description template.</td> replaced in the function description
<td><em>function description</em></td> template.</td>
<td>function description</td>
</tr> </tr>
<tr><td>fileheader</td> <tr><td>fileheader</td>
<td>The file header template. This wildcard will <td>The file header template. This wildcard
only be replaced in filetype templates.</td> will only be replaced in filetype
<td><em>filetypes</em></td> templates.</td>
<td>filetypes</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -2376,55 +2417,55 @@ matching options.</td>
<tr><td>GEANY_MAX_AUTOCOMPLETE_WORDS</td> <tr><td>GEANY_MAX_AUTOCOMPLETE_WORDS</td>
<td>How many auto completion suggestions should <td>How many auto completion suggestions should
Geany provide.</td> Geany provide.</td>
<td><em>30</em></td> <td>30</td>
</tr> </tr>
<tr><td>GEANY_MAX_AUTOCOMPLETE_HEIGHT</td> <tr><td>GEANY_MAX_AUTOCOMPLETE_HEIGHT</td>
<td>How many suggestions should be visible in <td>How many suggestions should be visible in
the auto completion list.</td> the auto completion list.</td>
<td><em>10</em></td> <td>10</td>
</tr> </tr>
<tr><td>GEANY_PROJECT_EXT</td> <tr><td>GEANY_PROJECT_EXT</td>
<td>The default filename extension for Geany <td>The default filename extension for Geany
project files. It is used when creating new project files. It is used when creating new
projects and as filter mask for the project projects and as filter mask for the project
open dialog.</td> open dialog.</td>
<td><em>geany</em></td> <td>geany</td>
</tr> </tr>
<tr><td>GEANY_STRING_UNTITLED</td> <tr><td>GEANY_STRING_UNTITLED</td>
<td>A string used as the default name for new <td>A string used as the default name for new
files. Be aware that the string can be files. Be aware that the string can be
translated, so change it only if you know translated, so change it only if you know
what you are doing.</td> what you are doing.</td>
<td><em>untitled</em></td> <td>untitled</td>
</tr> </tr>
<tr><td>GEANY_CHECK_FILE_DELAY</td> <tr><td>GEANY_CHECK_FILE_DELAY</td>
<td>Time in seconds between checking a file for <td>Time in seconds between checking a file for
external changes.</td> external changes.</td>
<td><em>30</em></td> <td>30</td>
</tr> </tr>
<tr><td>GEANY_TOGGLE_MARK</td> <tr><td>GEANY_TOGGLE_MARK</td>
<td>A string which is used to mark a toggled <td>A string which is used to mark a toggled
comment. comment.
external changes.</td> external changes.</td>
<td><em>&quot;~ &quot;</em></td> <td>&quot;~ &quot;</td>
</tr> </tr>
<tr><td>GEANY_WINDOW_MINIMAL_WIDTH</td> <tr><td>GEANY_WINDOW_MINIMAL_WIDTH</td>
<td>The minimal width of the main window.</td> <td>The minimal width of the main window.</td>
<td><em>620</em></td> <td>620</td>
</tr> </tr>
<tr><td>GEANY_WINDOW_MINIMAL_HEIGHT</td> <tr><td>GEANY_WINDOW_MINIMAL_HEIGHT</td>
<td>The minimal height of the main window.</td> <td>The minimal height of the main window.</td>
<td><em>440</em></td> <td>440</td>
</tr> </tr>
<tr><td>GEANY_WINDOW_DEFAULT_WIDTH</td> <tr><td>GEANY_WINDOW_DEFAULT_WIDTH</td>
<td>The default width of the main window at the <td>The default width of the main window at the
first start.</td> first start.</td>
<td><em>900</em></td> <td>900</td>
</tr> </tr>
<tr><td>GEANY_WINDOW_DEFAULT_HEIGHT</td> <tr><td>GEANY_WINDOW_DEFAULT_HEIGHT</td>
<td>The default height of the main window at the <td>The default height of the main window at the
first start.</td> first start.</td>
<td><em>600</em></td> <td>600</td>
</tr> </tr>
<tr><td><strong>Default values</strong></td> <tr><td><strong>Default values</strong></td>
<td>&nbsp;</td> <td>&nbsp;</td>
@ -2432,45 +2473,45 @@ first start.</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_TOOLS_MAKE</td> <tr><td>GEANY_DEFAULT_TOOLS_MAKE</td>
<td>The make tool. This can also include a path.</td> <td>The make tool. This can also include a path.</td>
<td><em>&quot;make&quot;</em></td> <td>&quot;make&quot;</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_TOOLS_TERMINAL</td> <tr><td>GEANY_DEFAULT_TOOLS_TERMINAL</td>
<td>A terminal emulator. It has to accept the <td>A terminal emulator. It has to accept the
command line option &quot;-e&quot;. This can also command line option &quot;-e&quot;. This can also
include a path.</td> include a path.</td>
<td><em>&quot;xterm&quot;</em></td> <td>&quot;xterm&quot;</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_TOOLS_BROWSER</td> <tr><td>GEANY_DEFAULT_TOOLS_BROWSER</td>
<td>A web browser. This can also include a path.</td> <td>A web browser. This can also include a path.</td>
<td><em>&quot;firefox&quot;</em></td> <td>&quot;firefox&quot;</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_TOOLS_PRINTCMD</td> <tr><td>GEANY_DEFAULT_TOOLS_PRINTCMD</td>
<td>A printing tool. It should be able to accept <td>A printing tool. It should be able to accept
and process plain text files. This can also and process plain text files. This can also
include a path.</td> include a path.</td>
<td><em>&quot;lpr&quot;</em></td> <td>&quot;lpr&quot;</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_TOOLS_GREP</td> <tr><td>GEANY_DEFAULT_TOOLS_GREP</td>
<td>A grep tool. It should be compatible with <td>A grep tool. It should be compatible with
GNU grep. This can also include a path.</td> GNU grep. This can also include a path.</td>
<td><em>&quot;grep&quot;</em></td> <td>&quot;grep&quot;</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_MRU_LENGHTH</td> <tr><td>GEANY_DEFAULT_MRU_LENGHTH</td>
<td>The length of the &quot;Recent files&quot; list.</td> <td>The length of the &quot;Recent files&quot; list.</td>
<td><em>10</em></td> <td>10</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_FONT_SYMBOL_LIST</td> <tr><td>GEANY_DEFAULT_FONT_SYMBOL_LIST</td>
<td>The font used in sidebar to show symbols and <td>The font used in sidebar to show symbols and
open files.</td> open files.</td>
<td><em>&quot;Sans 9&quot;</em></td> <td>&quot;Sans 9&quot;</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_FONT_MSG_WINDOW</td> <tr><td>GEANY_DEFAULT_FONT_MSG_WINDOW</td>
<td>he font used in the messages window.</td> <td>The font used in the messages window.</td>
<td><em>&quot;Sans 9&quot;</em></td> <td>&quot;Sans 9&quot;</td>
</tr> </tr>
<tr><td>GEANY_DEFAULT_FONT_EDITOR</td> <tr><td>GEANY_DEFAULT_FONT_EDITOR</td>
<td>The font used in the editor window.</td> <td>The font used in the editor window.</td>
<td><em>&quot;Monospace 10&quot;</em></td> <td>&quot;Monospace 10&quot;</td>
</tr> </tr>
<tr><td><strong>Windows specific</strong></td> <tr><td><strong>Windows specific</strong></td>
<td>&nbsp;</td> <td>&nbsp;</td>
@ -2484,7 +2525,7 @@ default Windows file dialogs are missing
some nice features like choosing a filetype some nice features like choosing a filetype
or an encoding. <em>Do not touch this setting or an encoding. <em>Do not touch this setting
when building on a non-Win32 system.</em></td> when building on a non-Win32 system.</em></td>
<td><em>0</em></td> <td>0</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -2855,7 +2896,7 @@ USE OR PERFORMANCE OF THIS SOFTWARE.</p>
<div class="footer"> <div class="footer">
<hr class="footer" /> <hr class="footer" />
<a class="reference" href="geany.txt">View document source</a>. <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. 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> </div>

363
doc/geany.txt
View File

@ -1,7 +1,7 @@
.. |(version)| replace:: 0.12 .. |(version)| replace:: 0.12
======= =======
Geany Geany
======= =======
------------------------- -------------------------
@ -189,9 +189,9 @@ Short option Long option Function
*none* --ft-names Print a list of Geany's internal filetype names (useful *none* --ft-names Print a list of Geany's internal filetype names (useful
for the auto completion list). for the auto completion list).
-i --new-instance Do not open files in a running instance, force opening a -i --new-instance Do not open files in a running instance, force opening
new instance. Only available if Geany was compiled with a new instance. Only available if Geany was compiled
support for Sockets. with support for Sockets.
-l --line Set initial line number for the first opened file. -l --line Set initial line number for the first opened file.
@ -206,27 +206,28 @@ Short option Long option Function
-s --no-session Do not load the previous session's files. -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 -t --no-terminal Do not load terminal support. Use this option if you do
not want to load the virtual terminal emulator widget at not want to load the virtual terminal emulator widget
startup. If you do not have libvte.so.4 installed, then at startup. If you do not have libvte.so.4 installed,
terminal-support is automatically disabled. Only available then terminal-support is automatically disabled. Only
if Geany was compiled with support for VTE. available if Geany was compiled with support for VTE.
*none* --vte-lib Specify explicitly the path including filename or only *none* --vte-lib Specify explicitly the path including filename or only
the filename to the VTE library, e.g. ``/usr/lib/libvte.so`` the filename to the VTE library, e.g.
or ``libvte.so``. This option is only needed when the ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
autodetection does not work. Only available if Geany was only needed when the autodetection does not work. Only
compiled with support for VTE. available if Geany was compiled with support for VTE.
-v --version Show version information and exit. -v --version Show version information and exit.
-? --help Show help information and exit. -? --help Show help information and exit.
*none* [files ...] Open all given files at startup. This option causes Geany *none* [files ...] Open all given files at startup. This option causes
to ignore loading stored files from the last session (if Geany to ignore loading stored files from the last
enabled). 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,9 +451,7 @@ before the selected text was copied to the new position.
Auto indentation Auto indentation
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
Geany knows three types of auto indentation: None, Basic and Advanced. Geany knows three types of auto indentation:
Auto indentation types:
None None
Disables auto indentation completely. Disables auto indentation completely.
@ -926,7 +925,7 @@ For C/C++ files, the environment variable CFLAGS should be set with
appropriate ``-I/path`` include paths. The following example works with appropriate ``-I/path`` include paths. The following example works with
the bash shell, generating tags for the GnomeUI library:: 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 /usr/include/libgnomeui-2.0/gnome.h
You can adapt this command to use CFLAGS and header files appropriate You can adapt this command to use CFLAGS and header files appropriate
@ -1060,6 +1059,7 @@ VTE tab in preferences dialog
.. image:: ./images/pref_dialog_vte.png .. image:: ./images/pref_dialog_vte.png
Project Management Project Management
------------------ ------------------
@ -1313,8 +1313,9 @@ But this depends on a2ps and xfprint4. As a replacement for xfprint4,
gtklp or similar programs can be used. gtklp or similar programs can be used.
.. note:: .. note::
The printing support of Geany will be improved in the future. With GTK The printing support of Geany will be improved in the future. With
2.10, better printing (including syntax highlighting) will be possible. GTK 2.10, better printing (including syntax highlighting) will be
possible.
@ -1344,7 +1345,7 @@ The following table lists all customizable keyboard shortcuts.
=============================== ========================================= =============================== =========================================
Action Description Action Description
=============================== ========================================= =============================== =========================================
**Menu items** ... **Menu items**
New Creates a new file. New Creates a new file.
@ -1414,7 +1415,7 @@ Fold all Folds all contractible code blocks.
Unfold all Unfolds all contracted code blocks. Unfold all Unfolds all contracted code blocks.
**Build options** ... **Build options**
Compile Compiles the current file. Compile Compiles the current file.
@ -1437,7 +1438,7 @@ Run (alternative command) Executes the current file in a terminal emulatio
Build options Opens the build options dialog. Build options Opens the build options dialog.
**Miscellaneous** ... **Miscellaneous**
Reload symbol list Reloads the tag/symbol list. Reload symbol list Reloads the tag/symbol list.
@ -1459,10 +1460,10 @@ Switch to last used document Switches to the previously selected open documen
Navigate forward a location Switches to the next location in the navigation Navigate forward a location Switches to the next location in the navigation
history. history.
Navigate back a location Switches to the previous location in the navigation Navigate back a location Switches to the previous location in the
history. navigation history.
**Editing operations** ... **Editing operations**
Convert selection to lower case Converts the current selection to lower case. Convert selection to lower case Converts the current selection to lower case.
@ -1470,11 +1471,14 @@ Convert selection to upper case Converts the current selection to upper case.
Duplicate line or selection Duplicates the current line or selection. 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. Transpose current line Transposes the current line with the previous one.
@ -1486,26 +1490,29 @@ Toggle line commentation Comments a line if it is not commented or remove
a comment if the line is commented. a comment if the line is commented.
Increase indent Indents the current line or selection by one tab 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 Decrease indent Removes one tabulator or the amount fo spaces of
tab width setting from the indentation of the current the tab width setting from the indentation of the
line or selection. 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 Smart line indent Indents the current line or all selected lines
the same intentation as the previous line. with the same intentation as the previous line.
Goto matching brace If the cursor is ahead or behind a brace, then it is Goto matching brace If the cursor is ahead or behind a brace, then it
moved to the brace which belongs to the current one. is moved to the brace which belongs to the current
If this keyboard shortcut is pressed again, the cursor one. If this keyboard shortcut is pressed again,
is moved back to the first brace. the cursor is moved back to the first brace.
Toggle marker Set a marker on the current line, or clear the marker Toggle marker Set a marker on the current line, or clear the
if there already is one. marker if there already is one.
Goto next marker Goto the next marker in the current document. Goto next marker Goto the next marker in the current document.
@ -1513,54 +1520,62 @@ Goto previous marker Goto the previous marker in the current document
Complete word Shows auto completion list. 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 Show macro list Shows a list of available macros and variables in
workspace. the workspace.
Complete construct If you type a construct like if or for and press this Complete construct If you type a construct like if or for and press
key, it will be completed with a matching template. 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 Suppress construct completion If you type a construct like if or for and press
key, it will not be completed, and a space or tab will this key, it will not be completed, and a space or
be inserted, depending on what the construct completion tab will be inserted, depending on what the
keybinding is set to. For example, if you have set the construct completion keybinding is set to. For
construct completion keybinding to space, then setting example, if you have set the construct completion
this to Shift+space will prevent construct completion keybinding to space, then setting this to
and insert a space. Shift+space will prevent construct completion and
insert a space.
Select current word Selects the current word under the cursor. Select current word Selects the current word under the cursor.
Select current paragraph Selects the current paragraph under the cursor which is Select current paragraph Selects the current paragraph under the cursor
defined by two empty lines around it. 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. Scroll to current line Scrolls the current line into the centre of the
The cursor position and or an existing selection will not view. The cursor position and or an existing
be changed. selection will not be changed.
Insert alternative whitespace Inserts a tabulator character when spaces should be used Insert alternative whitespace Inserts a tabulator character when spaces should
for indentation and inserts space characters of the amount be used for indentation and inserts space
of a tabulator width when tabulators should be used for characters of the amount of a tabulator width when
indentation. tabulators should be used for indentation.
Find Usage Finds all occurrences of the current word (near the keyboard Find Usage Finds all occurrences of the current word (near
cursor) or selection and displays them in the messages window. 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 Go to tag definition Jump to the definition of the current word (near
cursor). If the definition cannot be found (e.g. the relevant the keyboard cursor). If the definition cannot be
file is not open) Geany will beep and do nothing. See the found (e.g. the relevant file is not open) Geany
section called `Go to tag definition`_. 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 Go to tag declaration Jump to the declaration of the current word (near
cursor). If the declaration cannot be found (e.g. the relevant the keyboard cursor). If the declaration cannot be
file is not open) Geany will beep and do nothing. See the section found (e.g. the relevant file is not open) Geany
called `Go to tag definition`_. 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 Context Action Executes a command and passes the current word
postion) or selection as an argument. See the section called (near the cursor postion) or selection as an
`Context actions`_. argument. See the section called `Context
actions`_.
=============================== ========================================= =============================== =========================================
@ -1587,9 +1602,9 @@ contain all settings.
.. note:: .. note::
This feature is mainly intended for package maintainers or system This feature is mainly intended for package maintainers or system
admins who want to set up Geany in a multi user environment and set admins who want to set up Geany in a multi user environment and
some sane default values for this environment. Usual users won't need set some sane default values for this environment. Usual users won't
to do that. need to do that.
@ -1666,8 +1681,9 @@ wordchars
*Example:* (look at system filetypes.\* files) *Example:* (look at system filetypes.\* files)
comment_open comment_open
A character or string which is used to comment code. If you want to use A character or string which is used to comment code. If you want to
multiline comments, also set comment_close, otherwise leave it empty. use multiline comments, also set comment_close, otherwise leave it
empty.
*Example:* ``comment_open=/*`` *Example:* ``comment_open=/*``
@ -1679,35 +1695,37 @@ comment_close
comment_use_indent comment_use_indent
Set this to false if a comment character or string should start at 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 Note: Comment indentation
``comment_use_indent=true`` would generate this if a line is commented ``comment_use_indent=true`` would generate this if a line is
(e.g. with Ctrl-D):: commented (e.g. with Ctrl-D)::
#command_example(); #command_example();
``comment_use_indent=false`` would generate this if a line is commented ``comment_use_indent=false`` would generate this if a line is
(e.g. with Ctrl-D):: commented (e.g. with Ctrl-D)::
# command_example(); # command_example();
Note: This setting only works for single line comments (like '//', '#' Note: This setting only works for single line comments (like '//',
or ';'). '#' or ';').
*Example:* ``comment_use_indent=true`` *Example:* ``comment_use_indent=true``
context_action_cmd context_action_cmd
A command which can be executed on a certain word or the current A command which can be executed on a certain word or the current
selection. Example usage: Open the API documentation for the current selection. Example usage: Open the API documentation for the
function call at the cursor position. The command can be set for every current function call at the cursor position. The command can
filetype or if not set, a global command will be used. The command be set for every filetype or if not set, a global command will
itself can be specified without the full path, then it is searched be used. The command itself can be specified without the full
in $PATH. But for security reasons, it is recommended to specify the path, then it is searched in $PATH. But for security reasons,
full path to the command. The wildcard %s will be replaced by the it is recommended to specify the full path to the command. The
current word at the cursor position or by the current selection. 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: Hint: for PHP files the following could be quite useful:
context_action_cmd=firefox "http://www.php.net/%s" context_action_cmd=firefox "http://www.php.net/%s"
@ -1771,8 +1789,8 @@ selection
* Use background colour * Use background colour
The colours are only set if the 3rd or 4th argument is true. When 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 the colours are not overridden, the default is a dark grey
with syntax highlighted foreground text. background with syntax highlighted foreground text.
*Example:* ``selection=0xc0c0c0;0x00007F;true;true`` *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
@ -1793,9 +1811,10 @@ caret
*Example:* ``caret=0x000000;0x0;false;false`` *Example:* ``caret=0x000000;0x0;false;false``
caret_width caret_width
The width for the caret(the blinking cursor). Only the first argument The width for the caret(the blinking cursor). Only the first
is interpreted. The width is specified in pixels with a maximum of argument is interpreted. The width is specified in pixels with
three pixel. Use the width 0 to make the caret invisible. a maximum of three pixel. Use the width 0 to make the caret
invisible.
*Example:* ``caret=1;0;false;false`` *Example:* ``caret=1;0;false;false``
@ -1824,7 +1843,8 @@ white_space
*Example:* ``white_space=0xc0c0c0;0xffffff;true;true`` *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
folding_style 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: Valid values for the first argument are:
@ -1856,7 +1876,8 @@ invert_all
single line. Please note, at time of writing this was only tested single line. Please note, at time of writing this was only tested
with the C syntax highlighting. 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`` *Example:* ``invert_all=0;0;false;false``
@ -1970,44 +1991,76 @@ the New command is used without a filetype. This is empty by default.
Customizing templates Customizing templates
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
Each template can be customized to your needs. The templates are stored Each template can be customized to your needs. The templates are
in the ``~/.geany/templates/`` directory (see the section called `Command stored in the ``~/.geany/templates/`` directory (see the section called
line options`_ for further information about the configuration `Command line options`_ for further information about the configuration
directory). Just open the desired template with an editor (ideally, directory). Just open the desired template with an editor (ideally,
Geany ;-) ) and edit the template to your needs. There are some Geany ;-) ) and edit the template to your needs. There are some
wildcards which will be automatically replaced by Geany at startup. wildcards which will be automatically replaced by Geany at startup.
Template wildcards Template wildcards
`````````````````` ``````````````````
All wildcards must be enclosed by "{" and "}", e.g. {date}. All wildcards must be enclosed by "{" and "}", e.g. {date}.
============== =============================================== ============== ============== ============================================= ==============
Wildcard Description Available in Wildcard Description Available in
============== =============================================== ============== ============== ============================================= ==============
developer The name of the developer. *filetypes, file header, function description, ChangeLog entry, bsd, gpl* developer The name of the developer. filetypes, file header, function
initial The developer's initials, e.g. "ET" for Enrico *filetypes, file header, function description, ChangeLog entry, bsd, gpl* description, ChangeLog entry, bsd,
Tröger or "JFD" for John Foobar Doe. 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*) initial The developer's initials, e.g. "ET" for filetypes, file header, function
year The current year in the format: YYYY. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*) Enrico Tröger or "JFD" for John Foobar Doe. description, ChangeLog entry, bsd,
version The initial version of a new file. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*) 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*) mail The email address of the developer. file header, function description,
to your locale), used in filetype templates. ChangeLog entry, bsd, gpl
geanyversion The actual Geany version, e.g. *filetypes, file header, function description, ChangeLog entry, bsd, gpl*)
"Geany |(version)|". company The company the developer is working for. filetypes, file header, function
datetime The current date and time in the format: *file header, function description* 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. 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* filename The filename of the current file. file header
bsd This wildcard inserts a BSD licence notice. *file header*
functionname The function name of the function at the *function description* 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 cursor position. This wildcard will only be
replaced in the function description template. replaced in the function description
fileheader The file header template. This wildcard will *filetypes* template.
only be replaced in filetype templates.
============== =============================================== ============== fileheader The file header template. This wildcard filetypes
will only be replaced in filetype
templates.
============== ============================================= ==============
@ -2115,60 +2168,60 @@ not listed here should not be changed.
.. note:: .. note::
Most users should not need to change these options. Most users should not need to change these options.
============================== ============================================ ======= ============================== ============================================ ==================
Option Description Default Option Description Default
============================== ============================================ ======= ============================== ============================================ ==================
GEANY_WORDCHARS These characters define word boundaries when *look at sourcecode* GEANY_WORDCHARS These characters define word boundaries when *look at sourcecode*
making selections and searching using word making selections and searching using word
matching options. matching options.
GEANY_MAX_AUTOCOMPLETE_WORDS How many auto completion suggestions should *30* GEANY_MAX_AUTOCOMPLETE_WORDS How many auto completion suggestions should 30
Geany provide. Geany provide.
GEANY_MAX_AUTOCOMPLETE_HEIGHT How many suggestions should be visible in *10* GEANY_MAX_AUTOCOMPLETE_HEIGHT How many suggestions should be visible in 10
the auto completion list. the auto completion list.
GEANY_PROJECT_EXT The default filename extension for Geany *geany* GEANY_PROJECT_EXT The default filename extension for Geany geany
project files. It is used when creating new project files. It is used when creating new
projects and as filter mask for the project projects and as filter mask for the project
open dialog. open dialog.
GEANY_STRING_UNTITLED A string used as the default name for new *untitled* GEANY_STRING_UNTITLED A string used as the default name for new untitled
files. Be aware that the string can be files. Be aware that the string can be
translated, so change it only if you know translated, so change it only if you know
what you are doing. what you are doing.
GEANY_CHECK_FILE_DELAY Time in seconds between checking a file for *30* GEANY_CHECK_FILE_DELAY Time in seconds between checking a file for 30
external changes. external changes.
GEANY_TOGGLE_MARK A string which is used to mark a toggled *"~ "* GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
comment. comment.
external changes. external changes.
GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. *620* 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_MINIMAL_HEIGHT The minimal height of the main window. 440
GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the *900* GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
first start. first start.
GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the *600* GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
first start. first start.
**Default values** **Default values**
GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. *"make"* 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"* GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept the "xterm"
command line option "-e". This can also command line option "-e". This can also
include a path. include a path.
GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. *"firefox"* 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"* GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
and process plain text files. This can also and process plain text files. This can also
include a path. include a path.
GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with *"grep"* GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
GNU grep. This can also include a path. GNU grep. This can also include a path.
GEANY_DEFAULT_MRU_LENGHTH The length of the "Recent files" list. *10* 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"* GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
open files. open files.
GEANY_DEFAULT_FONT_MSG_WINDOW he font used in the messages window. *"Sans 9"* 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"* GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
**Windows specific** **Windows specific**
GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default *0* GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
Windows file open and save dialogs instead Windows file open and save dialogs instead
GTK's file open and save dialogs. The GTK's file open and save dialogs. The
default Windows file dialogs are missing default Windows file dialogs are missing
some nice features like choosing a filetype some nice features like choosing a filetype
or an encoding. *Do not touch this setting or an encoding. *Do not touch this setting
when building on a non-Win32 system.* when building on a non-Win32 system.*
============================== ============================================ ======= ============================== ============================================ ==================