ctys-xdg

November, 2010

.

NAME

ctys-xdg - Manages FreeDesktop entries


SYNTAX


ctys-xdg


   [-d]
   [-e]
   [--force]
   [--helpEx|-helpEx]
   [-h|--help|-help]
   [--menu-cancel]
   [--menu-cancel=<config-template-root-or-home-pathname>]
   [--menu-create]
   [--menu-create=<config-template-root-or-home-pathname>]
   [--menu-edit]
   [--menu-edit=<files-or-directories>]
   [--menu-gui]
   [--menu-private]
   [--menu-private=<target-base>]
   [--menu-shared]
   [--menu-shared=<target-base>]
   [--no-user]
   [--user]
   [-V]
   [-X]




DESCRIPTION

UNDER DEVELOPMENT: The current interface may change and the functionality will be expanded. For now basic features for template based private and shared menues are included. The validated support is mainly for Gnome desktops. KDE works almost too, some icon problems still remain, shifted due to priorities.

ctys-xdg is the main interface for the creation of menues and integration of the UnifiedSessionsManager into a graphical desktop. This includes the creation of the entries as well as removing them.

The Gnome desktops are provided by default, others require the --force option. This is due to limited support with some restrictions, though the user may decide case-by-case to apply or not. The installation of menues could be performed during installation by the ctys-distribute(1) utility too, but this does not provide a '--force' flag.

The following examples show the creation of the standard menue.

  ctys-xdg --menu-create

When applied to KDE desktops the '--force' option is required.

  ctys-xdg --menu-create --force

Whereas the following removes the entries but keeps the empty directories.

  ctys-xdg --menu-cancel


.

OPTIONS

-d <debug-args>
Refer to "ctys" generic options for additional information.

-e
Calls the configured editor by CTYS_MENUEDIT with the search path MENU_DEFAULT_PRIVATE_LST, which is set by default to
  $HOME/.config/menus:$HOME/.local/share/applications:\
  $HOME/.local/share/desktop-directories


--force
Forces the application to additional desktops.

-h
Print help, refer to "-H" for additional information.

-H <help-option>
The extended help option is based on system interfaces for display of manpages, PDF and HTML documents. This comprises the man pages and installed manuals.

For additional help refer to the documents or type ctys-xdg -H help .

--menu-cancel
Removes the entries as currently present within the templates. Directories are not removed.

--menu-create
Creates the standard menue entries as provided by the pre-defined templates. The templates are stored within the conficuration directory in xdg.d.

--menu-create=<config-template-root-or-home-pathname>
The same as --menu-create with additional alternative path for installation.

--menu-edit
The same as -e option.

--menu-gui
Sets GUI based messages and dialogues as preference.

--menu-private
Creates a private menu. This is the default.

--menu-private=<target-base>
The same as --menu-private with alternative directory.

--menu-shared
Creates a shared menue within standard path, this requires root permissions.

--menu-shared=<target-base>
The same as --menu-shared with an alternative base path.

--no-user
This is required when a menue entry without a user local installation is going to be used. This stores the required environment for shared executables within a init file and prepends the call into the menu entries.

--user
The default for user based installation, which assumes the environment is set during each login.

-V
Version.

-X
Terse output format, effects "-V" when set left-of.

.

ARGUMENTS

None.

.

EXIT-VALUES

0: OK:
Result is valid.

1: NOK:
Erroneous parameters.

2: NOK:
Missing an environment element like files or databases.


SEE ALSO

ctys-configuration-Gnome(7) , ctys - User Manual , ctys-distribute(1)




AUTHOR

Written and maintained by Arno-Can Uestuensoez:

Maintenance: <<acue_sf1 (a) sourceforge net>>
Homepage: <https://arnocan.wordpress.com>
Sourceforge.net: <http://sourceforge.net/projects/ctys>
Project moved from Berlios.de to OSDN.net: <https://osdn.net/projects/ctys>
Commercial: <https://arnocan.wordpress.com>




COPYRIGHT

Copyright (C) 2008, 2009, 2010 Ingenieurbuero Arno-Can Uestuensoez

For BASE package following licenses apply,

This document is part of the DOC package,

For additional information refer to enclosed Releasenotes and License files.