-
-
- General Startup preferences
-
-
- Startup -
- Shutdown -
- Paths +
- Preferences
-
+
- General Startup preferences -
- General Miscellaneous preferences
-
-
- Miscellaneous -
- Search -
- Projects +
- General Miscellaneous preferences -
- Interface preferences
-
-
- Sidebar -
- Fonts -
- Miscellaneous +
- Interface preferences -
- Interface Notebook tab preferences
-
-
- Editor tabs -
- Tab positions +
- Interface Notebook tab preferences -
- Interface Toolbar preferences
-
-
- Toolbar -
- Appearance +
- Interface Toolbar preferences -
- Editor Features preferences
-
-
- Features +
- Editor Features preferences -
- Editor Indentation preferences
-
-
- Indentation group +
- Editor Indentation preferences -
- Editor Completions preferences
-
-
- Completions -
- Auto-close quotes and brackets +
- Editor Completions preferences -
- Editor Display preferences
-
-
- Display -
- Long line marker -
- Virtual spaces +
- Editor Display preferences -
- Files preferences
-
-
- New files -
- Saving files -
- Miscellaneous +
- Files preferences -
- Tools preferences
-
-
- Tool paths -
- Commands +
- Tools preferences -
- Template preferences
-
-
- Template data +
- Template preferences -
- Keybinding preferences -
- Printing preferences -
- Various preferences -
- Terminal (VTE) preferences -
- Project management
-
-
- New project -
- Project properties -
- Open project -
- Close project +
- Project management -
- Build menu
-
-
- Indicators -
- Default build menu items
-
-
- Compile -
- Build -
- Make -
- Make custom target -
- Make object -
- Next error -
- Previous error -
- Execute -
- Stopping running processes
-
-
- Terminal emulators +
- Build menu
-
+
- Indicators +
- Default build menu items -
- Build menu configuration -
- Build menu commands dialog -
- Printing support -
- Plugins
-
-
- Plugin manager +
- Printing support +
- Plugins -
- Keybindings
-
-
- Switching documents -
- Configurable keybindings
-
-
- File keybindings -
- Editor keybindings -
- Clipboard keybindings -
- Select keybindings -
- Insert keybindings -
- Format keybindings -
- Settings keybindings -
- Search keybindings -
- Go to keybindings -
- View keybindings -
- Focus keybindings -
- Notebook tab keybindings -
- Document keybindings -
- Project keybindings -
- Build keybindings -
- Tools keybindings -
- Help keybindings +
- Keybindings
-
+
- Switching documents +
- Configurable keybindings
-
+
- File keybindings +
- Editor keybindings +
- Clipboard keybindings +
- Select keybindings +
- Insert keybindings +
- Format keybindings +
- Settings keybindings +
- Search keybindings +
- Go to keybindings +
- View keybindings +
- Focus keybindings +
- Notebook tab keybindings +
- Document keybindings +
- Project keybindings +
- Build keybindings +
- Tools keybindings +
- Help keybindings
- - Configuration files
-
-
- Configuration file paths
-
-
- Paths on Unix-like systems -
- Paths on Windows +
- Configuration files
-
+
- Configuration file paths -
- Tools menu items -
- Global configuration file -
- Filetype definition files
-
-
- Filenames -
- System files -
- User files -
- Custom filetypes
-
-
- Creating a custom filetype from an existing filetype +
- Tools menu items +
- Global configuration file +
- Filetype definition files
-
+
- Filenames +
- System files +
- User files +
- Custom filetypes -
- Filetype configuration
-
-
- [styling] section
-
-
- Using a named style -
- Reading styles from another filetype +
- Filetype configuration -
- Special file filetypes.common -
- Filetype extensions -
- Filetype group membership -
- Preferences file format
-
-
- [build-menu] section +
- Filetype extensions +
- Filetype group membership +
- Preferences file format -
- Project file format
-
-
- [build-menu] additions +
- Project file format -
- Templates
-
-
- Template meta data -
- File templates
-
-
- Adding file templates +
- Templates
-
+
- Template meta data +
- File templates -
- Customizing templates
-
-
- Template wildcards -
- Customizing the toolbar -
- Plugin documentation
-
-
- HTML Characters
-
-
- Insert entity dialog -
- Replace special chars by its entity
-
-
- At typing time -
- Bulk replacement +
- Plugin documentation
-
+
- HTML Characters -
- Save Actions -
- Contributing to this document -
- Scintilla keyboard commands
-
-
- Keyboard commands +
- Contributing to this document +
- Scintilla keyboard commands -
- Tips and tricks
-
-
- Document notebook -
- Editor -
- Interface -
- GTK-related +
- Tips and tricks -
- Compile-time options
-
-
- src/geany.h -
- project.h -
- filetypes.c -
- editor.h -
- keyfile.c -
- build.c +
- Compile-time options -
- GNU General Public License -
- License for Scintilla and SciTE +
- GNU General Public License +
- License for Scintilla and SciTE
@@ -616,6 +620,10 @@ $ make% make install
+Or via sudo:
++% sudo make install +
Waf based build system
@@ -1698,17 +1706,22 @@ word is used instead. This can be customized by theFind usage
-Find usage searches all open files. It is similar to the Find All In -Session option in the Find dialog.
+Find Usage searches all open files. It is similar to the Find All In +Session option in the Find dialog.
If there is a selection, then it is used as the search text; otherwise the current word is used. The current word is either taken from the word nearest the edit cursor, or the word underneath the popup menu click position when the popup menu is used. The search results are shown in the Messages tab of the Message Window.
++Note
+You can also use Find Usage for symbol list items from the popup +menu.
+Find in files
-Find in files is a more powerful version of Find usage that searches +
Find in Files is a more powerful version of Find Usage that searches all files in a certain directory using the Grep tool. The Grep tool must be correctly set in Preferences to the path of the system's Grep utility. GNU Grep is recommended (see note below).
@@ -2005,22 +2018,24 @@ corresponding filetype is first used. Currently these are for:Global tags file format
-Global tags files can have two different formats:
+Global tags files can have three different formats:
- Tagmanager format
- Pipe-separated format +
- CTags format
The first line of global tags files should be a comment, introduced -by # followed by a space and a string like format=pipe -or format=tagmanager respectively, these are case-sensitive. -This helps Geany to read the file properly. If this line -is missing, Geany tries to auto-detect the used format but this +by # followed by a space and a string like format=pipe, +format=ctags or format=tagmanager respectively, these are +case-sensitive. This helps Geany to read the file properly. If this +line is missing, Geany tries to auto-detect the used format but this might fail.
The Tagmanager format is a bit more complex and is used for files created by the geany -g command. There is one tag per line. Different tag attributes like the return value or the argument list are separated with different characters indicating the type of the -following argument.
+following argument. This is the more complete and recommended tag +format.+Pipe-separated format
The Pipe-separated format is easier to read and write. @@ -2042,9 +2057,18 @@ empty but the pipe separator must appear for them.
Just save them in your tags directory, as described earlier in the section Global tags.+CTags format
+This is the format that ctags generates, and that is used by Vim. +This format is compatible with the format historically used by Vi.
+The format is described at http://ctags.sourceforge.net/FORMAT, but +for the full list of existing extensions please refer to ctags. +However, note that Geany may actually only honor a subset of the +existing extensions.
+-Generating a global tags file
+Generating a global tags file
You can generate your own global tags files by parsing a list of source files. The command is:
@@ -2067,7 +2091,7 @@ don't want to specify the CFLAGS environment variable. geany -g wxd.d.tags /home/username/wxd/wx/*.d
-Generating C/C++ tag files
+Generating C/C++ tag files
You may need to first setup the C ignore.tags file.
For C/C++ tag files gcc is required by default, so that header files can be preprocessed to include any other headers they depend upon. If @@ -2083,7 +2107,7 @@ CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \ for whichever libraries you want.
-Generating tag files on Windows
+Generating tag files on Windows
This works basically the same as on other platforms:
"c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php @@ -2092,7 +2116,7 @@ for whichever libraries you want.
-C ignore.tags
+C ignore.tags
You can ignore certain tags for C-based languages if they would lead to wrong parsing of the code. Use the Tools->Configuration Files->ignore.tags menu item to open the user ignore.tags file. @@ -2130,7 +2154,7 @@ that items like G_GNUC_PRINTF+ get parsed correctly.
-Preferences
+Preferences
You may adjust Geany's settings using the Edit --> Preferences dialog. Any changes you make there can be applied by hitting either the Apply or the OK button. These settings will persist between Geany @@ -2147,10 +2171,10 @@ when restarting Geany.
comes after the screenshot of that tab.-General Startup preferences
+General Startup preferences
-Startup
+Startup
- Load files from the last session
- On startup, load the same files you had open the last time you @@ -2162,7 +2186,7 @@ used Geany.
-General Miscellaneous preferences
+General Miscellaneous preferences
-Miscellaneous
+Miscellaneous
- Beep on errors when compilation has finished
- Have the computer make a beeping sound when compilation of your program @@ -2222,7 +2246,7 @@ goto line fields and the VTE.
-Interface preferences
+Interface preferences
-Sidebar
+Sidebar
- Show sidebar
- Whether to show the sidebar at all. @@ -2275,7 +2299,7 @@ to perform some common operations such as saving, closing and reloading.
-Fonts
+Fonts
- Editor
- Change the font used to display documents. @@ -2286,7 +2310,7 @@ to perform some common operations such as saving, closing and reloading.
-Miscellaneous
+Miscellaneous
- Show status bar
- Show the status bar at the bottom of the main window. It gives information about @@ -2296,10 +2320,10 @@ modifications were done, the file encoding, the filetype and other information.<
-Interface Notebook tab preferences
+Interface Notebook tab preferences
-Editor tabs
+Editor tabs
- Show editor tabs
- Show a notebook tab for all documents so you can switch between them @@ -2319,7 +2343,7 @@ when double-clicking on a notebook tab.
-Tab positions
+Tab positions
- Editor
- Set the positioning of the editor's notebook tabs to the right, @@ -2334,11 +2358,11 @@ right, left, top, or bottom of the message window.
-Interface Toolbar preferences
+Interface Toolbar preferences
Affects the main toolbar underneath the menu bar.
-Toolbar
+Toolbar
- Show Toolbar
- Whether to show the toolbar. @@ -2350,7 +2374,7 @@ This is useful to save vertical space.
-Appearance
+Appearance
- Icon Style
- Select the toolbar icon style to use - either icons and text, just @@ -2363,10 +2387,10 @@ The choice System default uses whatever icon size is set by GTK.
-Editor Features preferences
+Editor Features preferences
-Features
+Features
- Line wrapping
- Show long lines wrapped around to new display lines. @@ -2389,7 +2413,10 @@ is folded. them in the editor area.
- Newline strips trailing spaces
- Remove any whitespace at the end of the line when you hit the -Enter/Return key. See also Strip trailing spaces. +Enter/Return key. See also Strip trailing spaces. Note +auto indentation is calculated before stripping, so although this +setting will clear a blank line, it will not set the next line +indentation back to zero.
- Line breaking column
- The editor column number to insert a newline at when Line Breaking is enabled for the current document. @@ -2400,10 +2427,10 @@ It is used to mark the comment as toggled.
-Editor Indentation preferences
+Editor Indentation preferences
-Indentation group
+Indentation group
See Indentation for more information.
- Width @@ -2455,10 +2482,10 @@ meanings in different contexts - e.g. for snippet completion.
-Editor Completions preferences
+Editor Completions preferences
-Completions
+Completions
- Snippet Completion
- Whether to replace special keywords after typing Tab into a @@ -2515,7 +2542,7 @@ updated upon document saving.
-Auto-close quotes and brackets
+Auto-close quotes and brackets
Geany can automatically insert a closing bracket and quote characters when you open them. For instance, you type a ( and Geany will automatically insert ). With the following options, you can define for which @@ -2535,11 +2562,11 @@ characters this should work.
-Editor Display preferences
+Editor Display preferences
This is for visual elements displayed in the editor window.
-Display
+Display
- Invert syntax highlighting colors
- Invert all colors, by default this makes white text on a black @@ -2564,7 +2591,7 @@ Otherwise you can scroll one more page even if there are no real lines.
-Long line marker
+Long line marker
The long line marker helps to indicate overly-long lines, or as a hint to the user for when to break the line.
-
@@ -2589,7 +2616,7 @@ where it should appear.
-Virtual spaces
+Virtual spaces
Virtual space is space beyond the end of each line. The cursor may be moved into virtual space but no real space will be added to the document until there is some text typed or some other @@ -2605,10 +2632,10 @@ text insertion command is used.
-Files preferences
+Files preferences
-New files
+New files
- Open new documents from the command-line
- Whether to create new documents when passing filenames that don't @@ -2628,7 +2655,7 @@ On Unix-like systems, LF is default and CR is used on MAC systems.
-Saving files
+Saving files
Perform formatting operations when a document is saved. These can each be undone with the Undo command.
-
@@ -2657,7 +2684,7 @@ saving, avoiding mixed line endings in the same file.
-Miscellaneous
+Miscellaneous
- Recent files list length
- The number of files to remember in the recently used files list. @@ -2676,10 +2703,10 @@ not checked for changes due to performance issues
-Tools preferences
+Tools preferences
-Tool paths
+Tool paths
- Terminal
- The command to execute a script in a terminal. Occurrences of %c @@ -2699,7 +2726,7 @@ Mingw project for instance might not work with Geany at the moment.
-Commands
+Commands
- Context action
- Set this to a command to execute on the current word. @@ -2709,13 +2736,13 @@ to the specified command.
-Template preferences
+Template preferences
This data is used as meta data for various template text to insert into a document, such as the file header. You only need to set fields that you want to use in your template files.
-Template data
+Template data
- Developer
- The name of the developer who will be creating files. @@ -2748,7 +2775,7 @@ which can be used with the ANSI C strftime function. For details please see
-Keybinding preferences
+Keybinding preferences
There are some commands listed in the keybinding dialog that are not, by default, bound to a key combination, and may not be available as a menu item.
@@ -2758,7 +2785,7 @@ bound to a key combination, and may not be available as a menu item.-Printing preferences
+Printing preferences
- Use external command for printing @@ -2780,17 +2807,17 @@ see http://man.cx/st
-Various preferences
+Various preferences
Rarely used preferences, explained in the table below. A few of them require restart to take effect, and a few other will only affect newly opened or created documents before restart.
-- - + + + - Key @@ -2876,7 +2903,7 @@ tab.statusbar_template The status bar statistics line format. -(Search in src/ui_utils.c for details). +(See Statusbar Templates for details).See below. immediately true immediately - -By default, statusbar_template is empty. This tells Geany to use its -internal default, which is currently:
-line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S
-Note that \t = tab.
--
- - -- - - - Key -Description -Default -Applies -VTE related The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX.
++Statusbar Templates
+The default statusbar template is (note \t = tab):
+line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S
+Settings the preference to an empty string will also cause Geany to use this +internal default.
+The following format characters are available for the statusbar template:
++
++ + ++ + Placeholder +Description +%l +The current line number starting at 1 +%L +The total number of lines +%c +The current column number starting at 0 +%C +The current column number starting at 1 +%s +The number of selected characters or if only whole lines +selected, the number of selected lines. +%w +Shows RO when the document is in read-only mode, +otherwise shows whether the editor is in overtype (OVR) +or insert (INS) mode. +%t +Shows the indentation mode, either tabs (TAB), +spaces (SP) or both (T/S). +%m +Shows whether the document is modified (MOD) or nothing. +%M +The name of the document's line-endings (ex. Unix (LF)) +%e +The name of the document's encoding (ex. UTF-8). +%f +The filetype of the document (ex. None, Python, C, etc). +%S +The name of the scope where the caret is located. +%p +The caret position in the entire document starting at 0. +%r +Shows whether the document is read-only (RO) or nothing. +%Y +The Scintilla style number at the caret position. This is +useful if you're debugging color schemes or related code. +-Terminal (VTE) preferences
+Terminal (VTE) preferences
See also: Virtual terminal emulator widget (VTE).
-Terminal widget
+Terminal widget
- Terminal font
- Select the font that will be used in the terminal emulation control. @@ -3102,7 +3179,7 @@ like a Python console (e.g. ipython). Use this with care.
-Project management
+Project management
Project management is optional in Geany. Currently it can be used for:
- Storing and opening session files on a project basis. @@ -3120,7 +3197,7 @@ Geany is shutdown. When restarting Geany, the previously opened project file that was in use at the end of the last session will be reopened.
The project menu items are detailed below.
-New project
+New project
To create a new project, fill in the Name field. By default this will setup a new project file ~/projects/name.geany. Usually it's best to store all your project files in the same directory (they are @@ -3130,7 +3207,7 @@ can safely be set to any existing path -- it will not touch the file structure contained in it.
-Project properties
+Project properties
You can set an optional description for the project. Currently it's only used for a template wildcard - see Template wildcards.
The Base path field is used as the directory to run the Build menu commands. @@ -3142,7 +3219,7 @@ project, which can be used in the Indentation settings.
-Open project
+Open project
The Open command displays a standard file chooser, starting in ~/projects. Choose a project file named with the .geany extension.
@@ -3150,14 +3227,14 @@ extension. open files and open the session files associated with the project.-Close project
+Close project
Project file settings are saved when the project is closed.
When project session support is enabled, Geany will close the project session files and open any previously closed default session files.
-Indicators
+Indicators
Indicators are red squiggly underlines which are used to highlight errors which occurred while compiling the current file. So you can easily see where your code failed to compile. You can remove them by @@ -3193,7 +3270,7 @@ selecting Remove Error Indicators in the Document menu.
preferences.-Make custom target
+Make custom target
This is similar to running 'Make' but you will be prompted for the make target name to be passed to the Make tool. For example, typing 'clean' in the dialog prompt will run "make clean".
-Make object
+Make object
Make object will run "make current_file.o" in the same directory as the current file, using the filename for 'current_file'. It is useful for building just the current file without building the whole project.
-Previous error
+Previous error
The previous error item will move to the previous detected error in the file.
-Execute
+Execute
Execute will run the corresponding executable file, shell script or interpreted script in a terminal window. The command set in the "Set Build Commands" dialog is run in a script to ensure the terminal @@ -3274,7 +3351,7 @@ output from the program before the terminal window is closed.
-Stopping running processes
+Stopping running processes
When there is a running program, the Execute menu item in the menu and the Run button in the toolbar each become a stop button so you can stop the current running program (and @@ -3283,7 +3360,7 @@ any child processes). This works by sending the SIGQUIT signal to the process.
-Terminal emulators
+Terminal emulators
The Terminal field of the tools preferences tab requires a command to execute the terminal program and to pass it the name of the Geany run script that it should execute in a Bourne compatible shell (eg /bin/sh). @@ -3297,7 +3374,7 @@ xterm -e "/bin/sh %c"
-Set build commands
+Set build commands
By default Compile, Build and Execute are fairly basic commands. You may wish to customise them using Set Build Commands.
E.g. for C you can add any include paths and compile flags for the @@ -3306,7 +3383,7 @@ arguments you want to use when running Execute.
-Printing support
+Printing support
Since Geany 0.13 there has been printing support using GTK's printing API. The printed page(s) will look nearly the same as on your screen in Geany. Additionally, there are some options to modify the printed page(s).
@@ -3594,7 +3671,7 @@ command line). gtklp or similar programs can be used.-Plugins
+Plugins
Plugins are loaded at startup, if the Enable plugin support general preference is set. There is also a command-line option, -p, which prevents plugins being loaded. Plugins are scanned in @@ -3610,7 +3687,7 @@ the following directories:
See also Plugin documentation for information about single plugins which are included in Geany.
-Plugin manager
+Plugin manager
The Plugin Manager dialog lets you choose which plugins should be loaded at startup. You can also load and unload plugins on the fly using this dialog. Once you click the checkbox for a specific plugin @@ -3621,13 +3698,13 @@ provides any.
-Keybindings
+Keybindings
Geany supports the default keyboard shortcuts for the Scintilla editing widget. For a list of these commands, see Scintilla keyboard commands. The Scintilla keyboard shortcuts will be overridden by any custom keybindings with the same keyboard shortcut.
-Switching documents
+Switching documents
There are some non-configurable bindings to switch between documents, listed below. These can also be overridden by custom keybindings.
@@ -3652,7 +3729,7 @@ listed below. These can also be overridden by custom keybindings.
See also Notebook tab keybindings.
-Configurable keybindings
+Configurable keybindings
For all actions listed below you can define your own keybindings. Open the Preferences dialog, select the desired action and click on change. In the resulting dialog you can press the key combination you @@ -3663,7 +3740,7 @@ combination can only be defined for one action.
which are common to many applications are marked with (C) after the shortcut.-Search keybindings
+Search keybindings
@@ -4166,7 +4243,7 @@ the highlighted matches will be cleared. -Go to keybindings
+Go to keybindings
@@ -4263,7 +4340,7 @@ If the line is not wrapped, it behaves like -Help keybindings
+Help keybindings
@@ -4639,13 +4716,13 @@ the last build process. -Configuration files
+Configuration files
Warning
You must use UTF-8 encoding without BOM for configuration files.
-Configuration file paths
+Configuration file paths
Geany has default configuration files installed for the system and also per-user configuration files.
The system files should not normally be edited because they will be @@ -4664,14 +4741,14 @@ Geany-INFO: System data dir: /usr/share/geany Geany-INFO: User config dir: /home/username/.config/geany
-Paths on Unix-like systems
+Paths on Unix-like systems
The system path is $prefix/share/geany, where $prefix is the path where Geany is installed (see Installation prefix).
The user configuration directory is normally: /home/username/.config/geany
-Paths on Windows
+Paths on Windows
The system path is the data subfolder of the installation path on Windows.
The user configuration directory might vary, but on Windows XP it's: @@ -4679,7 +4756,7 @@ on Windows.
-Global configuration file
+Global configuration file
System administrators can add a global configuration file for Geany which will be used when starting Geany and a user configuration file does not exist.
@@ -4719,14 +4796,14 @@ need to do that.-Filetype definition files
+Filetype definition files
All color definitions and other filetype specific settings are stored in the filetype definition files. Those settings are colors for syntax highlighting, general settings like comment characters or word delimiter characters as well as compiler and linker settings.
See also Configuration file paths.
-Filenames
+Filenames
Each filetype has a corresponding filetype definition file. The format for built-in filetype Foo is:
@@ -4767,7 +4844,7 @@ filetypes.Foo.conf
See the link for details.
-System files
+System files
The system-wide filetype configuration files can be found in the system configuration path and are called filetypes.$ext, where $ext is the name of the filetype. For every @@ -4781,7 +4858,7 @@ because they will be overridden when Geany is updated.
-User files
+User files
To change the settings, copy a file from the system configuration path to the subdirectory filedefs in your user configuration directory. Then you can edit the file and the changes will still be @@ -4791,7 +4868,7 @@ settings you want to change. All missing settings will be read from the corresponding system configuration file.
-Custom filetypes
+Custom filetypes
At startup Geany looks for filetypes.*.conf files in the system and user filetype paths, adding any filetypes found with the name matching the '*' wildcard - e.g. filetypes.Bar.conf.
@@ -4817,7 +4894,7 @@ support for the following has been implemented:See Filetype configuration for details on each setting.
-Creating a custom filetype from an existing filetype
+Creating a custom filetype from an existing filetype
Because most filetype settings will relate to the syntax highlighting (e.g. styling, keywords, lexer_properties sections), it is best to copy an existing filetype file that uses @@ -4838,11 +4915,11 @@ list, or none.
-Filetype configuration
+Filetype configuration
As well as the sections listed below, each filetype file can contain a [build-menu] section as described in [build-menu] section.
-[styling] section
+[styling] section
In this section the colors for syntax highlighting are defined. The manual format is:
-
@@ -4862,7 +4939,7 @@ value is something other than "true" or "false", "false
This makes the key style have red foreground text, default background color text and bold emphasis.
-Using a named style
+Using a named style
The second format uses a named style name to reference a style defined in filetypes.common.
-
@@ -4880,7 +4957,7 @@ italic emphasis.
Section.
-Reading styles from another filetype
+Reading styles from another filetype
You can automatically copy all of the styles from another filetype definition file by using the following syntax for the [styling] group:
@@ -4899,7 +4976,7 @@ styling the same as the C styling, you would put the following in-[keywords] section
+[keywords] section
This section contains keys for different keyword lists specific to the filetype. Some filetypes do not support keywords, so adding a new key will not work. You can only add or remove keywords to/from @@ -4910,7 +4987,7 @@ an existing list.
-[lexer_properties] section
+[lexer_properties] section
Here any special properties for the Scintilla lexer can be set in the format key.name.field=some.value.
Properties Geany uses are listed in the system filetype files. To find @@ -4920,7 +4997,7 @@ egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
-[settings] section
+[settings] section
- extension
This is the default file extension used when saving files, not @@ -5042,7 +5119,7 @@ this setting in their system configuration files.
-[indentation] section
+[indentation] section
This section allows definition of default indentation settings specific to the file type, overriding the ones configured in the preferences. This can be useful for file types requiring specific indentation settings (e.g. tabs @@ -5078,7 +5155,7 @@ only for Makefile). These settings don't override auto-detection if activated.<
-[build_settings] section
+[build_settings] section
As of Geany 0.19 this section is supplemented by the [build-menu] section. Values that are set in the [build-menu] section will override those in this section.
-
@@ -5131,7 +5208,7 @@ complete filename, e.g. for shell scripts.
-Special file filetypes.common
+Special file filetypes.common
There is a special filetype definition file called filetypes.common. This file defines some general non-filetype-specific settings.
@@ -5146,7 +5223,7 @@ the system file.See the Filetype configuration section for how to define styles.
-[named_styles] section
+[named_styles] section
Named styles declared here can be used in the [styling] section of any filetypes.* file.
For example:
@@ -5171,7 +5248,7 @@ original style.-[named_colors] section
+[named_colors] section
Named colors declared here can be used in the [styling] or [named_styles] section of any filetypes.* file or color scheme.
For example:
@@ -5187,7 +5264,7 @@ foo=my_red_color;my_blue_color;false;true scheme-wide only involves changing the hex value in a single location.-[styling] section
+[styling] section
- default
This is the default style. It is used for styling files without a @@ -5371,7 +5448,7 @@ arguments set whether to use the defined colors.
-[settings] section
+[settings] section
- whitespace_chars
Characters to treat as whitespace. These characters are ignored @@ -5385,7 +5462,7 @@ when moving, selecting and deleting across word boundaries
-Filetype extensions
+Filetype extensions
To change the default filetype extension used when saving a new file, see Filetype definition files.
You can override the list of file extensions that Geany uses to detect @@ -5405,7 +5482,7 @@ Make=Makefile*;*.mk;Buildfile;
-Filetype group membership
+Filetype group membership
Group membership is also stored in filetype_extensions.conf. This file is used to store information Geany needs at startup, whereas the separate filetype definition files hold information only needed when @@ -5426,13 +5503,13 @@ None=None;
-Preferences file format
+Preferences file format
The user preferences file geany.conf holds settings for all the items configured in the preferences dialog. This file should not be edited while Geany is running as the file will be overwritten when the preferences in Geany are changed or Geany is quit.
-Project file format
+Project file format
The project file contains project related settings and possibly a record of the current session files.
-Templates
+Templates
Geany supports the following templates:
- ChangeLog entry @@ -5513,7 +5590,7 @@ save a file in the user's template configuration directory. You can also force this by selecting Tools->Reload Configuration.
-Template meta data
+Template meta data
Meta data can be used with all templates, but by default user set meta data is only used for the ChangeLog and File header templates.
In the configuration dialog you can find a tab "Templates" (see @@ -5521,7 +5598,7 @@ meta data is only used for the ChangeLog and File header templates.
which will be inserted in the templates.-File templates
+File templates
File templates are templates used as the basis of a new file. To use them, choose the New (with Template) menu item from the File menu.
@@ -5533,7 +5610,7 @@ optional template wildcards like {fileheader}. wildcard can be placed anywhere, but it's usually put on the first line of the file, followed by a blank line.-Adding file templates
+Adding file templates
File templates are read from templates/files under the Configuration file paths.
The filetype to use is detected from the template file's extension, if @@ -5544,7 +5621,7 @@ clicked.
-Customizing templates
+Customizing templates
Each template can be customized to your needs. The templates are stored in the ~/.config/geany/templates/ directory (see the section called Command line options for further information about the configuration @@ -5552,7 +5629,7 @@ 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
+Template wildcards
All wildcards must be enclosed by "{" and "}", e.g. {date}.
Wildcards for character escaping
@@ -5696,7 +5773,7 @@ bsd, gpl, snippets.
geanyversion The actual Geany version, e.g. -"Geany 1.23". +"Geany 1.24".file templates, file header, function description, ChangeLog entry, bsd, gpl, snippets. @@ -5765,7 +5842,7 @@ will only be replaced in file templates.-Special {command:} wildcard
+Special {command:} wildcard
The {command:} wildcard is a special one because it can execute a specified command and put the command's output (stdout) into the template.
@@ -5800,14 +5877,14 @@ standard error and in the Help->Debug Messages dialog.-Customizing the toolbar
+Customizing the toolbar
You can add, remove and reorder the elements in the toolbar by using the toolbar editor, or by manually editing the configuration file ui_toolbar.xml.
The toolbar editor can be opened from the preferences editor on the Toolbar tab or by right-clicking on the toolbar itself and choosing it from the menu.
-Manually editing the toolbar layout
+Manually editing the toolbar layout
To override the system-wide configuration file, copy it to your user configuration directory (see Configuration file paths).
For example:
@@ -5829,7 +5906,7 @@ will be used instead.-Available toolbar elements
+Available toolbar elements
@@ -5943,13 +6020,13 @@ use 'SearchEntry') -Plugin documentation
+Plugin documentation
-HTML Characters
+HTML Characters
The HTML Characters plugin helps when working with special characters in XML/HTML, e.g. German Umlauts ü and ä.
-Insert entity dialog
+Insert entity dialog
When the plugin is enabled, you can insert special character entities using Tools->Insert Special HTML Characters.
This opens up a dialog where you can find a huge amount of special @@ -5961,7 +6038,7 @@ the entity for the character at the current cursor position. You might also like to double click the chosen entity instead.
-Replace special chars by its entity
+Replace special chars by its entity
To help make a XML/HTML document valid the plugin supports replacement of special chars known by the plugin. Both bulk replacement and immediate replacement during typing are supported.
@@ -5977,7 +6054,7 @@ replacement and immediate replacement during typing are supported.-At typing time
+At typing time
You can activate/deactivate this feature using the Tools->HTML Replacement->Auto-replace Special Characters menu item. If it's activated, all special characters (beside the given exceptions from @@ -5986,7 +6063,7 @@ above) known by the plugin will be replaced by their entities.
of this feature.-Bulk replacement
+Bulk replacement
After inserting a huge amount of text, e.g. by using copy & paste, the plugin allows bulk replacement of all known characters (beside the mentioned exceptions). You can find the function under the same @@ -5996,9 +6073,9 @@ configure a keybinding for the plugin.
-Save Actions
+Save Actions
-Instant Save
+Instant Save
This plugin sets on every new file (File->New or File->New (with template)) a randomly chosen filename and set its filetype appropriate to the used template or when no template was used, to a configurable default filetype. @@ -6008,7 +6085,7 @@ useful when you often create new files just for testing some code or something similar.
-Backup Copy
+Backup Copy
This plugin creates a backup copy of the current file in Geany when it is saved. You can specify the directory where the backup copy is saved and you can configure the automatically added extension in the configure dialog @@ -6019,7 +6096,7 @@ copied into the configured backup directory when the file is saved in Geany.
-Contributing to this document
+Contributing to this document
This document (geany.txt) is written in reStructuredText (or "reST"). The source file for it is located in Geany's doc subdirectory. If you intend on making changes, you should grab the @@ -6028,7 +6105,7 @@ editing the file, to build the HTML document to see how your changes look, run "make doc" in the subdirectory doc of Geany's source directory. This regenerates the geany.html file. To generate a PDF file, use the command "make pdf" which should generate a file called -geany-1.23.pdf.
+geany-1.24.pdf.After you are happy with your changes, create a patch e.g. by using:
% git diff geany.txt > foo.patch @@ -6051,7 +6128,7 @@ to build the docs. The package is named-Scintilla keyboard commands
+Scintilla keyboard commands
Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
This appendix is distributed under the terms of the License for Scintilla and SciTE. A copy of this license can be found in the file @@ -6060,7 +6137,7 @@ program and in the appendix of this document. See .
20 June 2006
-Keyboard commands
+Keyboard commands
Keyboard commands for Scintilla mostly follow common Windows and GTK+ conventions. All move keys (arrows, page up/down, home and end) allows to extend or reduce the stream selection when holding the @@ -6143,9 +6220,9 @@ menus. Some less common commands with no menu equivalent are:
-Tips and tricks
+Tips and tricks
-Document notebook
+Document notebook
- Double-click on empty space in the notebook tab bar to open a new document. @@ -6158,7 +6235,7 @@ shortcut). The interface pref must be enabled for this to work.
-Compile-time options
+Compile-time options
There are some options which can only be changed at compile time, and some options which are used as the default for configurable options. To change these options, edit the appropriate source file @@ -6201,7 +6278,7 @@ not be changed.
Most users should not need to change these options.
-keyfile.c
+keyfile.c
These are default settings that can be overridden in the Preferences dialog.
@@ -6426,7 +6503,7 @@ xterm -e "/bin/sh %c" -build.c
+build.c
@@ -6471,7 +6548,7 @@ overriding the compile setting. -GNU General Public License
+GNU General Public License
GNU GENERAL PUBLIC LICENSE Version 2, June 1991 @@ -6816,7 +6893,7 @@ Public License instead of this License.-License for Scintilla and SciTE
+License for Scintilla and SciTE
Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
All Rights Reserved
Permission to use, copy, modify, and distribute this software and @@ -6836,7 +6913,7 @@ USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/doc/geany.txt b/doc/geany.txt index 05592f1c..1067abbb 100644 --- a/doc/geany.txt +++ b/doc/geany.txt @@ -2489,65 +2489,53 @@ Rarely used preferences, explained in the table below. A few of them require restart to take effect, and a few other will only affect newly opened or created documents before restart. -================================ ========================================= ========== =========== -Key Description Default Applies -================================ ========================================= ========== =========== +================================ =========================================== ========== =========== +Key Description Default Applies +================================ =========================================== ========== =========== **Editor related** -use_gtk_word_boundaries Whether to look for the end of a word true to new - when using word-boundary related documents +use_gtk_word_boundaries Whether to look for the end of a word true to new + when using word-boundary related documents Scintilla commands (see `Scintilla keyboard commands`_). -brace_match_ltgt Whether to highlight <, > angle brackets. false immediately -complete_snippets_whilst_editing Whether to allow completion of snippets false immediately +brace_match_ltgt Whether to highlight <, > angle brackets. false immediately +complete_snippets_whilst_editing Whether to allow completion of snippets false immediately when editing an existing line (i.e. there is some text after the current cursor position on the line). Only used when the keybinding `Complete snippet` is set to ``Space``. -show_editor_scrollbars Whether to display scrollbars. If set to true immediately +show_editor_scrollbars Whether to display scrollbars. If set to true immediately false, the horizontal and vertical scrollbars are hidden completely. -indent_hard_tab_width The size of a tab character. Don't change 8 immediately +indent_hard_tab_width The size of a tab character. Don't change 8 immediately it unless you really need to; use the indentation settings instead. **Interface related** -show_symbol_list_expanders Whether to show or hide the small true to new - expander icons on the symbol list documents +show_symbol_list_expanders Whether to show or hide the small true to new + expander icons on the symbol list documents treeview. -allow_always_save Whether files can be saved always, even false immediately +allow_always_save Whether files can be saved always, even false immediately if they don't have any changes. By default, the Save button and menu item are disabled when a file is unchanged. When setting this option to true, the Save button and menu item are always active and files can be saved. -compiler_tab_autoscroll Whether to automatically scroll to the true immediately +compiler_tab_autoscroll Whether to automatically scroll to the true immediately last line of the output in the Compiler tab. -statusbar_template The status bar statistics line format. See below. immediately - (Search in src/ui_utils.c for details). -new_document_after_close Whether to open a new document after all false immediately +statusbar_template The status bar statistics line format. See below. immediately + (See `Statusbar Templates`_ for details). +new_document_after_close Whether to open a new document after all false immediately documents have been closed. -msgwin_status_visible Whether to show the Status tab in the true immediately +msgwin_status_visible Whether to show the Status tab in the true immediately Messages Window -msgwin_compiler_visible Whether to show the Compiler tab in the true immediately +msgwin_compiler_visible Whether to show the Compiler tab in the true immediately Messages Window -msgwin_messages_visible Whether to show the Messages tab in the true immediately +msgwin_messages_visible Whether to show the Messages tab in the true immediately Messages Window -msgwin_scribble_visible Whether to show the Scribble tab in the true immediately +msgwin_scribble_visible Whether to show the Scribble tab in the true immediately Messages Window -================================ ========================================= ========== =========== - -By default, statusbar_template is empty. This tells Geany to use its -internal default, which is currently: - -``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S`` - -Note that ``\t`` = tab. - -================================ =========================================== ========== =========== -Key Description Default Applies -================================ =========================================== ========== =========== **VTE related** emulation Terminal emulation mode. Only change this xterm immediately if you have VTE termcap files other than @@ -2609,6 +2597,43 @@ number_exec_menu_items The maximum number of menu items in the 2 The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX. +Statusbar Templates +``````````````````` + +The default statusbar template is (note ``\t`` = tab): + +``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S`` + +Settings the preference to an empty string will also cause Geany to use this +internal default. + +The following format characters are available for the statusbar template: + +============ =========================================================== +Placeholder Description +============ =========================================================== + ``%l`` The current line number starting at 1 + ``%L`` The total number of lines + ``%c`` The current column number starting at 0 + ``%C`` The current column number starting at 1 + ``%s`` The number of selected characters or if only whole lines + selected, the number of selected lines. + ``%w`` Shows ``RO`` when the document is in read-only mode, + otherwise shows whether the editor is in overtype (OVR) + or insert (INS) mode. + ``%t`` Shows the indentation mode, either tabs (TAB), + spaces (SP) or both (T/S). + ``%m`` Shows whether the document is modified (MOD) or nothing. + ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``) + ``%e`` The name of the document's encoding (ex. UTF-8). + ``%f`` The filetype of the document (ex. None, Python, C, etc). + ``%S`` The name of the scope where the caret is located. + ``%p`` The caret position in the entire document starting at 0. + ``%r`` Shows whether the document is read-only (RO) or nothing. + ``%Y`` The Scintilla style number at the caret position. This is + useful if you're debugging color schemes or related code. +============ =========================================================== + Terminal (VTE) preferences ^^^^^^^^^^^^^^^^^^^^^^^^^^
- HTML Characters
- [styling] section
- Configuration file paths