mirror of
https://codeberg.org/scip/config-general-mode.git
synced 2025-12-16 20:10:57 +01:00
prepared commentary section for el2markdown
This commit is contained in:
@@ -27,66 +27,66 @@
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
;;;; Introduction
|
||||
|
||||
;;;; 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 `<tab>' (using `dabbrev')
|
||||
;; - completion support with `TAB' (using `dabbrev')
|
||||
;; - imenu support for <blocks>
|
||||
;; - electric paring mode (for quotes, parens, etc) enabled
|
||||
;; - automatic indenting
|
||||
;; - jump to include file with `<ret>'
|
||||
|
||||
;;;; Installation
|
||||
;; - jump to include file with `C-return'
|
||||
|
||||
;;;; 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))
|
||||
|
||||
;;
|
||||
;; 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
|
||||
|
||||
;; Edit your config file as usual. Use `<tab>' for completion of
|
||||
;;;; Usage:
|
||||
;;
|
||||
;; Edit your config file as usual. Use `TAB' for completion of
|
||||
;; values and variables. Use `C-c C-t' to toggle flags (like true to
|
||||
;; false). Use `C-c C-=' on a region to automatically align on the `=`
|
||||
;; character. Use `C-c C-/' to breakup a region with long lines into
|
||||
;; shorter ones using backslash notation. Use `<C-return>' to visit
|
||||
;; shorter ones using backslash notation. Use `C-return' 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 `<C-k>' to delete
|
||||
;; the current one, indent and move point there. Use `C-k' to delete
|
||||
;; lines, including continuation lines or whole blocks. Use `C-c C-j'
|
||||
;; to jump to a block definition (same as using `imenu' with the
|
||||
;; mouse).
|
||||
|
||||
;;;; Customize
|
||||
|
||||
;;;; Customize:
|
||||
;;
|
||||
;; You can customize the mode with:
|
||||
|
||||
;;
|
||||
;; M-x customize-group RET config-general-mode RET
|
||||
|
||||
;;
|
||||
;; 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)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user