man/alacarte.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <refentry id="alacarte">
   6
   7         <refentryinfo>
   8                 <title>alacarte</title>
   9                 <productname>GNOME</productname>
  10
  11                 <authorgroup>
  12                         <author>
  13                                 <contrib>Developer</contrib>
  14                                 <firstname>Trevor</firstname>
  15                                 <surname>Watkins</surname>
  16                         </author>
  17                         <author>
  18                                 <contrib>Developer</contrib>
  19                                 <firstname>Jasper</firstname>
  20                                 <surname>St. Pierre</surname>
  21                         </author>
  22                 </authorgroup>
  23
  24         </refentryinfo>
  25
  26         <refmeta>
  27                 <refentrytitle>alacarte</refentrytitle>
  28                 <manvolnum>1</manvolnum>
  29                 <refmiscinfo class="manual">User Commands</refmiscinfo>
  30         </refmeta>
  31
  32         <refnamediv>
  33                 <refname>alacarte</refname>
  34                 <refpurpose>Edit freedesktop.org menus</refpurpose>
  35         </refnamediv>
  36
  37         <refsynopsisdiv>
  38                 <cmdsynopsis>
  39                         <command>alacarte</command>
  40                 </cmdsynopsis>
  41         </refsynopsisdiv>
  42
  43         <refsect1>
  44                 <title>Description</title>
  45
  46                 <para><application>alacarte</application> is a graphical
  47                 editor for the freedesktop.org menus that are used by
  48                 many desktop environments. It can also edit and create
  49                 application desktop files.</para>
  50
  51         </refsect1>
  52
  53         <refsect1>
  54                 <title>Options</title>
  55
  56                 <para><command>alacarte</command> does not accept any
  57                 commandline options.</para>
  58         </refsect1>
  59
  60         <refsect1>
  61                 <title>Environment</title>
  62
  63                 <variablelist>
  64                         <varlistentry>
  65                                 <term><envar>XDG_CONFIG_DIRS</envar></term>
  66                                 <listitem><para><command>alacarte</command> looks in the <filename>menus</filename> subdirectory of these directories for menu files. The default location for menu files is <filename>/etc/xdg/menus</filename>.</para></listitem>
  67                         </varlistentry>
  68                         <varlistentry>
  69                                 <term><envar>XDG_DATA_DIRS</envar></term>
  70                                 <listitem><para><command>alacarte</command> looks in the <filename>applications</filename> subdirectory of these directories for desktop files. The default location for desktop files is <filename>/usr/share/applications</filename>.</para></listitem>
  71                         </varlistentry>
  72                         <varlistentry>
  73                                 <term><envar>XDG_CONFIG_HOME</envar></term>
  74                                 <listitem><para>The <filename>menus</filename> subdirectory of this directory is where <command>alacarte</command> stores modified menu files. The default location for modified menu files is <filename><envar>$HOME</envar>/.config/menus</filename>.</para></listitem>
  75                         </varlistentry>
  76                         <varlistentry>
  77                                 <term><envar>XDG_DATA_HOME</envar></term>
  78                                 <listitem><para>The <filename>applications</filename> subdirectory of this directory is where <command>alacarte</command> stores modified and newly created desktop files. The default location for these is <filename><envar>$HOME</envar>/.local/share/applications</filename>.</para></listitem>
  79                         </varlistentry>
  80                         <varlistentry>
  81                                 <term><envar>XDG_MENU_PREFIX</envar></term>
  82                                 <listitem><para><command>alacarte</command> is editing the
  83                                 menus defined by the file <filename><envar>$XDG_MENU_PREFIX</envar>applications.menu</filename>. GNOME uses the menu file <filename>gnome-applications.menu</filename>.</para></listitem>
  84                         </varlistentry>
  85
  86                 </variablelist>
  87         </refsect1>
  88
  89 </refentry>