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

prepared commentary section for el2markdown

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

52
config-general-mode.el
View File

@@ -27,66 +27,66 @@
;;; Commentary: ;;; Commentary:
;;;; Introduction ;;;; Introduction:
;;
;; [Config::General](http://search.cpan.org/dist/Config-General/) is a ;; [Config::General](http://search.cpan.org/dist/Config-General/) is a
;; Perl module for parsing config files with some enhanced ;; Perl module for parsing config files with some enhanced
;; features. `config-general-mode' makes it easier to edit such config ;; features. `config-general-mode' makes it easier to edit such config
;; files with Emacs. ;; files with Emacs.
;;
;; It is based on `conf-mode' with the following features: ;; It is based on `conf-mode' with the following features:
;;
;; - good syntax highlighting for config files ;; - good syntax highlighting for config files
;; - completion support with `<tab>' (using `dabbrev') ;; - completion support with `TAB' (using `dabbrev')
;; - imenu support for <blocks> ;; - imenu support for <blocks>
;; - electric paring mode (for quotes, parens, etc) enabled ;; - electric paring mode (for quotes, parens, etc) enabled
;; - automatic indenting ;; - automatic indenting
;; - jump to include file with `<ret>' ;; - jump to include file with `C-return'
;;;; Installation
;;;; Installation:
;;
;; To use, save config-general-mode.el to a directory in your load-path. ;; To use, save config-general-mode.el to a directory in your load-path.
;;
;; Add something like this to your config: ;; Add something like this to your config:
;;
;; (require 'config-general-mode) ;; (require 'config-general-mode)
;; (add-to-list 'auto-mode-alist '("\\.conf$" . config-general-mode)) ;; (add-to-list 'auto-mode-alist '("\\.conf$" . config-general-mode))
;;
;; or load it manually, when needed: ;; or load it manually, when needed:
;;
;; M-x config-general-mode ;; M-x config-general-mode
;;
;; You can also enable it with a buffer-local variable by adding this as ;; You can also enable it with a buffer-local variable by adding this as
;; the first line of a config file: ;; the first line of a config file:
;;
;; # -*-config-general-*- ;; # -*-config-general-*-
;;;; Usage ;;;; Usage:
;;
;; Edit your config file as usual. Use `<tab>' for completion of ;; 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 ;; 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 `=` ;; 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 ;; 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 ;; 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' ;; lines, including continuation lines or whole blocks. Use `C-c C-j'
;; to jump to a block definition (same as using `imenu' with the ;; to jump to a block definition (same as using `imenu' with the
;; mouse). ;; mouse).
;;;; Customize ;;;; Customize:
;;
;; You can customize the mode with: ;; You can customize the mode with:
;;
;; M-x customize-group RET config-general-mode RET ;; 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 ;; You can also use hooks to config-general mode as a way to modify or enhance
;; its behavior. The following hooks are available: ;; its behavior. The following hooks are available:
;;
;; config-general-mode-hook ;; config-general-mode-hook
;;
;; For example: ;; For example:
;;
;; (add-hook 'config-general-mode-hook 'electric-indent-mode) ;; (add-hook 'config-general-mode-hook 'electric-indent-mode)