Formatting improvements to fvwm-menu-desktop manpage.

doc/fvwm-menu-desktop.adoc

@@ -6,117 +6,118 @@ fvwm-menu-desktop - Reads XDG menu files and creates Fvwm menus
 
 == SYNOPSIS
 
-fvwm-menu-desktop [ **--help**|*-h* ] [ *--version* ] [
+fvwm-menu-desktop [ *--help*|*-h* ] [ *--version* ] [
 *--install-prefix* _DIR_ ] [ *--desktop* _NAME_ ] [ *--menu-type* _NAME_
-] [ *--theme* _NAME_ ] [ **--with-titles**|*-w* ] [ *--without-titles* ]
-[ *--enable-mini-icons* ] [ **--size**|*-s* _NUM_ ] [ *--mini-icon-dir*
+] [ *--theme* _NAME_ ] [ *--with-titles*|*-w* ] [ *--without-titles* ]
+[ *--enable-mini-icons* ] [ *--size*|*-s* _NUM_ ] [ *--mini-icon-dir*
 _DIR_ ] [ *--app-icon* _NAME_ ] [ *--dir-icon* _NAME_ ] [
-**--title**|*-t* _NAME_ ] [ *--insert-in-menu* _NAME_ ] [ *--get-menus*
-__all__|_desktop_ ] [ *--set-menus* _menu_paths_ ] [ *--all-menus* ] [
+*--title*|*-t* _NAME_ ] [ *--insert-in-menu* _NAME_ ] [ *--get-menus*
+_all_|_desktop_ ] [ *--set-menus* _menu_paths_ ] [ *--all-menus* ] [
 *--include-items* _NAME_ ] [ *--regen-cmd* _CMD_ ] [ *--term-cmd* _CMD_
-] [ *--dynamic* ] [ **--menu-error**|*-e* ] [ **--verbose**|*-v* ]
+] [ *--dynamic* ] [ *--menu-error*|*-e* ] [ *--verbose*|*-v* ]
 
 == DESCRIPTION
 
 This is a python script which parses XDG menus definitions to build
 corresponding fvwm menus. This script depends on python-xdg to run.
 
-== OPTIONS
+== MAIN OPTIONS
 
-Main Options::
---help::
+*--help*::
   Show the help and exit.
---version::
+*--version*::
   Show the version and exit.
---get-menus all|desktop::
+*--get-menus* _all_|_desktop_::
   Prints a space separated list of full menu paths found on the system.
   _all_ will print all menus found on the system except empty ones.
   _desktop_ will print the menu(s) that would be generated by the
   script.
-
++
 No menu generation is done.
 
---desktop NAME::
+*--desktop* _NAME_::
   Optional parameter to set the _NAME_ of the desktop XDG .menu file(s)
   to use. This option will override any default menus set via
   *FvwmForm-XDGMenu-Config* and cause the script to find menus in which
   _NAME_ is a part of the file name. Possible names are: _gnome_, _kde_,
   _xfce_, _lxde_, _debian_, etc.
-
++
 This option can be used in conjunction with *--menu-type* to control
 which .menu file(s) are used.
 
---menu-type NAME::
+*--menu-type* _NAME_::
   Optional parameter to set the _NAME_ of the XDG menu type to use. This
   option will override any default menus set via
   *FvwmForm-XDGMenu-Config* and cause the script to find menus in which
   _NAME_ is a part of the file name. Possible _NAME_ types could be:
   _applications_, _settings_, _preferences_, etc.
-
++
 When used in conjunction with *--desktop*, only menus whose file name
 matches '*destkop*menutype*' are found. If no menus are found, the
 script exits with an error.
 
---all-menus::
+*--all-menus*::
   This option will build all menus found on the system. If used in
   conjunction with *--desktop* or *--menu-type* this will build all
   menus matching those settings.
---install-prefix DIR::
+*--install-prefix* _DIR_::
   Optional parameter to override the standard locations for XDG menu
   definitions. Tells *fvwm-menu-desktop* to look in _DIR_ for .menu
   files instead of the standard locations /etc/xdg/menus (and
   $HOME/.config/menus if it exists).
---with-titles|-w::
+*--with-titles*|*-w*::
   If this option is set menus are generated with titles. This is the
   default. This option can be used to override the
   *FvwmForm-XDGMenu-Config* default setting.
---without-titles::
+*--without-titles*::
   If this option is set menus are generated without titles. The default
   is to generate with titles.
---title|-t NAME ::
+*--title*|*-t* _NAME_::
   Option to define the menu title _NAME_ of the top menu used by Fvwm's
   *Menu* or *Popup* commands. Default is "XDGMenu".
---include-items NAME ::
+*--include-items* _NAME_::
   This option controls if the additional menu items 'Regenerate' and
   'Configure' are included in the top level menu. _NAME_ can be one of
   _regenerate_, _config_, _both_, or _none_. The default is _both_.
---regen-cmd CMD ::
+*--regen-cmd* _CMD_::
   This option sets the fvwm command _CMD_ that is run when the menu item
   'Regenerate' is selected. The default is "PipeRead
   `fvwm-menu-desktop`".
---term-cmd CMD ::
+*--term-cmd* _CMD_::
   This option sets the terminal emulator command _CMD_ that is used to
   to run terminal applications in. _CMD_ needs to end with an execute
   option, such as xterm's -e option, which will run the command that is
   appended to _CMD_. The default is "xterm -e".
---dynamic ::
+*--dynamic*::
   This option is to be used with creating dynamic menus using
   *DynamicPopUpAction* and *DynamicPopDownAction*. This adds a
   'recreate' to the *DestroyMenu* command on the top level menu so those
   actions are not Destroyed when the menu is regenerated.
---insert-in-menu NAME::
+*--insert-in-menu* _NAME_::
   Option to insert generated menu(s) *IN* a menu _NAME_ (its top title).
   This option makes it so the top level menu is not Destroyed and the
   items are added to the end.
-
++
 Note menus regenerated with this option will append the menu items at
 the end of the existing menu. Each time the menu is regenerated new menu
 items appear giving a growing menu of duplicate items. You have to
 regenerate the whole menu via a function or restart fvwm. See *EXAMPLES*
 below for some solutions.
 
---set-menus menu_paths::
+*--set-menus* _menu_paths_::
   Generates all menus listed in a space separated list of full menu
   paths. This option overrides any defaults and
   **--desktop**|*--menu-type* settings.
---menu-error |-e::
+*--menu-error*|*-e*::
   If this option is present and python-xdg is not found, the script will
   print the error in the generated menu. Used in the default-config.
---verbose::
+*--verbose*::
   Enables additional information printouts on STDERR.
-Icons Options::
-  By default, fvwm-menu-desktop builds menus without mini-icons. To
-  enable mini-icons use the following options.
+
+== ICONS OPTIONS
+
+By default, fvwm-menu-desktop builds menus without mini-icons. To
+enable mini-icons use the following options.
 
 If ImageMagick is installed on the system, the script will resize and
 copy the icons to $FVWM_USERDIR/.icons. This can take awhile. You should
@@ -125,29 +126,29 @@ icons have been generated the script should run faster. If it is still
 to slow using icons, see *EXAMPLES* for ways to limit how often the menu
 is generated to speed things up.
 
---enable-mini-icons::
+*--enable-mini-icons*::
   This option enables mini-icons in the menus. If set, 24x24 mini-icons
   are used. If the specified icon isn't that size it will be converted
   if *ImageMagick* is installed and saved in $HOME/.fvwm/icons or to the
   directory specified with --mini-icon-dir option. Otherwise no icon
   appears in the menu for that entry. With most distributions, all the
   menu entries will have mini-icons appropriate to the application.
---theme NAME::
+*--theme* _NAME_::
   Defines the used icon theme. Default is _gnome_ but all others found
   in /usr/share/icons could be used except the _hicolor_ theme because
   it's the default fallback theme if no icon is found.
---size|-s NUM::
+*--size*|*-s* _NUM_::
   If --enable-mini-icons is used the _size_ of the icons can changed
   with this parameter. Default is 24.
---mini-icon-dir DIR::
+*--mini-icon-dir* _DIR_::
   When the right size mini-icon isn't available, fvwm-menu-desktop
   creates icons with the right size in $HOME/.fvwm/icons. If you don't
   want to use the default directory, $HOME/.fvwm/icons, use this option
   to specify a different folder.
---app-icon NAME::
+*--app-icon* _NAME_::
   Sets the default application icon if no others are found. Default is
   'gnome-applications'.
---dir-icon NAME::
+*--dir-icon* _NAME_::
   Sets the default directory icon if no others are found. Default is
   'gnome-fs-directory'.