scip/config-general-mode
1
0
Fork 0
mirror of https://codeberg.org/scip/config-general-mode.git synced 2025-12-16 20:10:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

re-generated

Browse Source
This commit is contained in:
Thomas von Dein
2017-07-01 11:37:15 +02:00
parent 04e0522a6c
commit 4774b4decf
1 changed files with 32 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@@ -1,59 +1,58 @@
## config-general-mode
# config-general-mode - Emacs major editing mode for Config::General config files.
Emacs major editing mode for Config::General config files.
### Screenshot
## Screenshot
![demo](https://raw.githubusercontent.com/TLINDEN/config-general-mode/master/config-general-screenshot.png)
### Introduction
[Config::General](http://search.cpan.org/dist/Config-General/) is a
Perl module for parsing config files with some enhanced
features. [config-general-mode](https://github.com/TLINDEN/config-general-mode)
makes it easier to edit such config files with emacs.
## Introduction
[Config::General](http://search.cpan.org/dist/Config-General/) is a
Perl module for parsing config files with some enhanced
features. `config-general-mode` makes it easier to edit such config
files with Emacs.
It is based on `conf-mode` with the following features:
- good syntax highlighting for config files
- completion support with <kbd>tab</kbd> (using `dabbrev`)
- imenu support for `<blocks>`
- completion support with <kbd>TAB</kbd> (using `dabbrev`)
- imenu support for <blocks>
- electric paring mode (for quotes, parens, etc) enabled
- automatic indenting
- jump to include file with <kbd>return</kbd>
- jump to include file with <kbd>C-return</kbd>
### Installation
## Installation
To use, save config-general-mode.el to a directory in your load-path.
Add something like this to your config:
(require 'config-general-mode)
(add-to-list 'auto-mode-alist '("\\.conf$" . config-general-mode))
(require 'config-general-mode)
(add-to-list 'auto-mode-alist '("\\.conf$" . config-general-mode))
or load it manually, when needed:
M-x config-general-mode
You can also enable it with a buffer-local variable by adding this as
the first line of a config file:
# -*-config-general-*-
### Usage
## Usage
Edit your config file as usual. Use <kbd>tab</kbd> for completion of
values and variables. Use <kbd>C-c C-t</kbd> to toggle flags (like
true to false). Use <kbd>C-c C-=</kbd> on a region to automatically
align on the `=` character. Use <kbd>C-c C-/</kbd> to breakup a region
with long lines into shorter ones using backslash notation. Use
<kbd>C-return</kbd> to visit an included file or (when not on a link)
insert a new line below the current one, indent and move point there.
Use <kbd>C-k</kbd> to delete lines, including continuation lines or
whole blocks. Use <kbd>C-c C-j</kbd> to jump to a block definition
(same as using `imenu' with the mouse).
Edit your config file as usual. Use <kbd>TAB</kbd> for completion of
values and variables. Use <kbd>C-c C-t</kbd> to toggle flags (like true to
false). Use <kbd>C-c C-=</kbd> on a region to automatically align on the `=`
character. Use <kbd>C-c C-/</kbd> to breakup a region with long lines into
shorter ones using backslash notation. Use <kbd>C-return</kbd> to visit
an included file or (when not on a link) insert a new line below
the current one, indent and move point there. Use <kbd>C-k</kbd> to delete
lines, including continuation lines or whole blocks. Use <kbd>C-c C-j</kbd>
to jump to a block definition (same as using `imenu` with the
mouse).
### Customize
## Customize
You can customize the mode with:
@@ -63,15 +62,15 @@ You can also use hooks to config-general mode as a way to modify or enhance
its behavior. The following hooks are available:
config-general-mode-hook
For example:
(add-hook 'config-general-mode-hook 'electric-indent-mode)
(add-hook 'config-general-mode-hook 'electric-indent-mode)
### Meta
## Meta
Copyright (C) 2017, T.v.Dein <tlinden@cpan.org>
Copyright (C) 2017, T.v.Dein <tlinden AT cpan DOT org>
This file is NOT part of Emacs.
@@ -91,7 +90,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
- Version: 0.01
- Author: T.v.Dein <tlinden@cpan.org>
- Author: T.v.Dein <tlinden AT cpan DOT org>
- Keywords: config file editing
- URL: https://github.com/tlinden/config-general-mode
- License: GNU General Public License >= 2