Bump Standards-Version to 3.9.2

[grml-quickconfig.git] / grml-quickconfig.8

diff --git a/grml-quickconfig.8 b/grml-quickconfig.8
index 7641930..1082174 100644 (file)
--- a/grml-quickconfig.8
+++ b/grml-quickconfig.8
@@ -15,15 +15,34 @@ Directory to load the menu files from. Menu files have to end with '*.sh'.
 If menudir is an existing directory then files will be directly loaded from
 the specified directory. If it is not a directory it will be loaded from
 .B /usr/share/grml-quickconfig/MENUDIR/
 If menudir is an existing directory then files will be directly loaded from
 the specified directory. If it is not a directory it will be loaded from
 .B /usr/share/grml-quickconfig/MENUDIR/

-instead (if exists).
+instead (if present).

 
 If no option is provided the bootparameter
 .B menu
 (if present) is used as directory.
 
 If no option is provided the bootparameter
 .B menu
 (if present) is used as directory.

+
+If neither a commandline parameter nor a bootparameter is specified it will load the menu files from the default location
+.B /usr/share/grml-quickconfig
+
+If there exists a directory called
+.B local
+inside the default location it will be used for loading the menue.
+.SH Determing menu directory:
+.IP \(bu
+Command  line argument
+.IP \(bu
+boot parameter menu
+.IP \(bu
+.B /usr/share/grml-quickconfig/local/
+(if present)
+.IP \(bu
+.B /usr/share/grml-quickconfig/
+
+

 .SH NOTES
 grml-quickconfig provides a console based interface to get fast
 access to some basic grml-scripts like for example grml-network,
 .SH NOTES
 grml-quickconfig provides a console based interface to get fast
 access to some basic grml-scripts like for example grml-network,

-netcardconfig, grml-lang, grml-x and grml2hd.
+netcardconfig, grml-lang, grml-x and grml-debootstrap.

 .SH USAGE EXAMPLES
 .TP
 .B grml-quickconfig
 .SH USAGE EXAMPLES
 .TP
 .B grml-quickconfig


@@ -81,6 +100,22 @@ Highlight the used key inside the menu.
 .TP
 .B Example
  print_line "Configure ${HIGHLIGHT}n${NORMAL}etwork"
 .TP
 .B Example
  print_line "Configure ${HIGHLIGHT}n${NORMAL}etwork"

+
+.SS Shortcuts
+As highlighting the name as well as the keyboard shortcuts is common
+in a menu entry there are two shortcuts for highlighting.
+.SS Highlight a single character
+To highlight a single character, for example the shortcut, use
+.B ^
+and the next character will be highlighted. If you want to just write ^ escape the
+character with a backslash.
+ print_line "Configure ^network \\^ is nice"
+.SS Highlight a word
+To highlight a range, for example the command, use
+.B /word/
+and the text between / wll be highlighted. If you want to just write / escape the
+character with a backslash.
+ print_line "Configure ^network (/grml-network/)"

 .SS MUST Provide
 .TP
 .B display_entry
 .SS MUST Provide
 .TP
 .B display_entry


@@ -108,7 +143,7 @@ used in combination with print_line. Only used if display_entry returns 0.
 .RS
 .B \ Example
  # print Configure network (grml-network)
 .RS
 .B \ Example
  # print Configure network (grml-network)

- LINE='print_line "Configure ${HIGHLIGHT}n${NORMAL}etwork (${HIGHLIGHT_NAME}grml-network${NORMAL})"'
+ LINE='print_line "Configure ^network (/grml-network/)"'

 .RE 1
 .SS Optional entries
 The following variables are optional and can be defined in a script but do not have to.
 .RE 1
 .SS Optional entries
 The following variables are optional and can be defined in a script but do not have to.


@@ -135,8 +170,7 @@ KEY=(c d e)
 
 .SS Complete Example
  # language module for grml-quickconfig
 
 .SS Complete Example
  # language module for grml-quickconfig

- LINE='print_line "Set keyboard layout (${HIGHLIGHT_NAME}grml-lang${NORMAL}): \\
- ${HIGHLIGHT}d${NORMAL}e ${HIGHLIGHT}a${NORMAL}t ${HIGHLIGHT}c${NORMAL}h e${HIGHLIGHT}s${NORMAL} ${HIGHLIGHT}u${NORMAL}s"'
+ LINE='print_line "Set keyboard layout (/grml-lang/): ^de ^at ^ch e^s ^us"'

 
  typeset -A lang_mapping
 
 
  typeset -A lang_mapping