You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Frank Lanitz 0bfe89d1a4
Merge pull request #916 from eht16/overview_fix_cppcheck
1 month ago
addons Fixed document list menu position bug (#895) 3 months ago
autoclose autoclose: remove pairing quotes 3 months ago
automark automark: move initialization behind DOC_VALID check. Fixes #574. 6 months ago
build Post release version bump 1 month ago
codenav g_print: Add newline now Geany's g_print handler doesn't 1 month ago
commander Initialize loop variables to make cppcheck happy 2 years ago
debugger Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
defineformat defineformat: new plugin API requires version 1.26 (226) 1 year ago
devhelp Reorder NEWS 1 month ago
geanyctags Merge pull request #708 from LarsGit223/geanyctags-newapi 7 months ago
geanydoc Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
geanyextrasel Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
geanygendoc Initialize loop variables to make cppcheck happy 2 years ago
geanyinsertnum Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
geanylua Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
geanymacro Pass a GdkKeymap to gdk_keymap_* functions 2 years ago
geanyminiscript Merge pull request #360 from b4n/geanyminiscript/less-deprecated 3 years ago
geanynumberedbookmarks Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
geanypg Add note to plugins which are currently not activly maintained as marked inside MAINTAINERS 2 years ago
geanyprj geanyprj: fixed cut-off sidebar tab under gtk3 1 month ago
geanypy Fix typo on untested win32 build 2 years ago
geanyvc GeanyVC: Remove image from README as it appears to be gone 6 months ago
geniuspaste Geniuspaste: Enable HTTPS for pastebin.geany.org (#635) 2 years ago
git-changebar git-changebar: fix compatibility with libgit2 0.28 API 9 months ago
keyrecord Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
latex Update link to geany latex plugin docs 1 year ago
lineoperations lineoperations: add support for locale-aware sorting (#897) 2 months ago
lipsum lipsum: fixed deprecated gtk call for gtk3 6 months ago
markdown Markdown: add support for webkit2gtk 1 year ago
multiterm multiterm: Fix wrong plugin name in README 3 years ago
overview Overview: initialize color variables 1 month ago
pairtaghighlighter Added keybinding for jumping to matching tag 2 years ago
po Turkish translations updated 1 month ago
pohelper pohelper: Update X-Generator header if present 1 year ago
pretty-printer Translation: Fix a typo 1 year ago
projectorganizer Merge pull request #920 from techee/focus_sidebar 1 month ago
scope Merge pull request #882 from LarsGit223/inc-geanyplugins-h 3 months ago
sendmail Little cleanup of README 3 years ago
shiftcolumn Add note to plugins which are currently not activly maintained as marked inside MAINTAINERS 2 years ago
spellcheck SpellCheck: Improve custom dictionary configuration documentation 6 months ago
tableconvert tableconvert: fixed deprecated gtk call for gtk3 6 months ago
treebrowser Cleanup: fixed usage of '#include "geanyplugin.h"' 4 months ago
updatechecker updatechecker: remove duplicate config_file defn 2 months ago
utils workbench: added option to let git decide which files to display 3 months ago
vimode vimode: Don't use word navigation from Scintilla 1 month ago
webhelper Update README 10 months ago
workbench workbench: added short history to README 3 months ago
xmlsnippets XmlSnippets: enable test program on "make check" 2 years ago
.gitignore Extending gitignore for some tmp. TeX files 3 years ago
.travis.yml travis: Run distcheck as well 11 months ago
HACKING Remove waf from HACKING 4 years ago
MAINTAINERS Update MAINTAINERS 5 months ago
Makefile.am vimode: A Vim Mode for Geany 1 year ago
NEWS Post release version bump 1 month ago
README Add "vimode" plugin to README 11 months ago
README.rst Create README.rst link (#461) 3 years ago
README.template Fix various list-related reStructuredText typos 7 years ago
autogen.sh Make sure to abort if any of the commands in autogen.sh fails 7 years ago
configure.ac Post release version bump 1 month ago

README

===============
Geany-Plugins
===============

Status
------

.. image:: https://travis-ci.org/geany/geany-plugins.svg?branch=master
:target: https://travis-ci.org/geany/geany-plugins

Installation
------------

You can build the plugins using Autotools.

Building with Autotools
^^^^^^^^^^^^^^^^^^^^^^^

You can use Autotools to build the Geany plugins in this repository.

Usage::

./configure [arguments] or alternatively ./autogen.sh [arguments]
make
sudo make install

autogen.sh will call configure in background and is only available if
you are using Geany plugins from git repository. It is not included in
release packages.

However, this will configure, build and install most of the Geany plugins.
There is some auto-detection in place which automagically disables
some of the plugins if there are insufficient build dependencies.
The following arguments can tweak the behaviour of the configure
script.

Options
=======
A full listing of all supported options can be found in ``./configure --help``.

Enable/Disable Features
=======================
The following options can be passed to ``./configure`` in forms
``--enable-<option>=auto`` (default), ``--enable-<option>``,
``--disable-<option>``. In all cases, ``--enable-<option>=auto`` causes the
feature to be enabled/disabled automatically based on whether the dependency
exists on your system.
``--enable-<option>`` causes the feature to be forcefully enabled, causing
configure to fail with an error message if you have missing
dependencies.
``--disable-<option>`` causes the feature to be forcefully disabled.

Available plugins are:

* ``addons`` -- the Addons plugin
* ``autoclose`` -- the Autoclose plugin
* ``automark`` -- the Automark plugin
* ``codenav`` -- the CodeNav plugin
* ``commander`` -- the Commander plugin
* ``debugger`` -- the Debugger plugin
* ``defineformat`` -- the Defineformat plugin
* ``devhelp`` -- the devhelp plugin
* ``geanyctags`` -- the GeanyCtags plugin
* ``geanydoc`` -- the GeanyDoc plugin
* ``geanyextrasel`` -- the GeanyExtraSel plugin
* ``geanygendoc`` -- the GeanyGenDoc plugin
* ``geanyinsertnum`` -- the GeanyInsertNum plugin
* ``geanylua`` -- the GeanyLua plugin
* ``geanymacro`` -- the GeanyMacro plugin
* ``geanyminiscript`` -- the GeanyMiniScript plugin
* ``geanynumberedbookmarks`` -- the GeanyNumberedBookmarks plugin
* ``geanypg`` -- the geanypg plugin
* ``geanyprj`` -- the GeanyPrj plugin
* ``geanypy`` -- the Geanypy plugin
* ``geanyvc`` -- the GeanyVC plugin
* ``geniuspaste`` -- the paste to a pastebin plugin
* ``gitchangebar`` -- the GitChangeBar plugin
* ``gtkspell`` -- GeanyVC's spell-check support
* ``latex`` -- the LaTeX plugin
* ``lineoperations`` -- simple line functions that can be applied to an open file
* ``lipsum`` -- the Lipsum plugin
* ``markdown`` -- the Markdown plugin
* ``multiterm`` -- the multiterm plugin
* ``overview``-- the overview plugin
* ``pairtaghighlighter`` -- the PairTagHighlighter plugin
* ``peg-markdown`` -- use the Peg-Markdown library in the Markdown plugin
* ``pohelper`` -- the PoHelper plugin
* ``pretty_printer`` -- the pretty-printer plugin
* ``projectorganizer`` -- the ProjectOrganizer plugin
* ``scope`` -- the Scope plugin
* ``sendmail`` -- the GeanySendmail plugin
* ``shiftcolumn`` -- the ShiftColumn plugin
* ``spellcheck`` -- the spellcheck plugin
* ``tableconvert`` -- the Tableconvert plugin
* ``treebrowser`` -- the Treebrowser plugin
* ``updatechecker`` -- the Updatechecker plugin
* ``vimode`` -- the Vim-mode plugin
* ``webhelper`` -- the WebHelper plugin
* ``xmlsnippets`` -- the XMLSnippets plugin

Example::

./configure --enable-geanylua --enable-spellcheck

This will force both geanylua and spellcheck plugins to be enabled even
if some dependencies are missing.

You can also use the special option ``all-plugins`` to change the default for all
plugins. For example, using ``--enable-all-plugins`` will forcefully enable all
plugins as if you passed each plugin-specific ``--enable-<option>``. This can be
combined with specific plugin's ``--enable-<option>`` to only select a specific
subset of the plugins without listing them all. For example, you can use this
to easily enable one single plugin, using e.g. ``--disable-all-plugins
--enable-<option>``, or to forcefully enable all plugins but a few specific
ones, using e.g. ``--enable-all-plugins --enable-<option>=auto``.


Other tweaks
============
The following options can be passed to ``./configure`` in the form
``--with-<option>=<argument>``.

* ``lua-pkg`` -- the name of the Lua pkg-config package name.
* ``geany-prefix`` -- Geany's prefix, used when compiling Geany.


Compiling Individual Plugins
============================

The Geany Plugins project uses a recursive Automake build system,
which means that after running ``./configure``, you may compile each
individual plugin by cd-ing into the respective plugin directory
and running make inside it.