gnome-init

## gnome-init gnome-init — Functions used during initialisation of libgnome and other platform libraries. |

## Synopsis

    #include <libgnome/libgnome.h>

    #define             LIBGNOME_MODULE

    const GnomeModuleInfo * libgnome_module_info_get        (void);
    const GnomeModuleInfo *  gnome_bonobo_module_info_get   (void);

    const char *        gnome_user_dir_get                  (void);
    const char *        gnome_user_private_dir_get          (void);
    const char *        gnome_user_accels_dir_get           (void);

## Description

## Details

### LIBGNOME_MODULE

    #define LIBGNOME_MODULE libgnome_module_info_get()

This macro wraps the call to `libgnome_module_info_get()` and is the usual way of retrieving the GnomeModuleInfo returned by this function.

### libgnome_module_info_get ()

    const GnomeModuleInfo * libgnome_module_info_get        (void);

Retrieves the current libgnome version and the modules it depends on.

Returns : | a new GnomeModuleInfo structure describing the version and the versions of the dependents.

### gnome_bonobo_module_info_get ()

    const GnomeModuleInfo *  gnome_bonobo_module_info_get   (void);

Retrieves the bonobo module version and indicate that it requires the current libgnome and its dependencies (although libbonobo does not depend on libgnome, libbonoboui does and this will also be initialised when initialising a GNOME app).

Returns : | a new GnomeModuleInfo structure describing the version of the bonobo modules and its dependents.

### gnome_user_dir_get ()

    const char *        gnome_user_dir_get                  (void);

Retrieves the user-specific directory for GNOME apps to use ($HOME/.gnome2 is the usual GNOME 2 value).

Returns : | An absolute path to the directory.

### gnome_user_private_dir_get ()

    const char *        gnome_user_private_dir_get          (void);

Differs from `gnome_user_dir_get()` in that the directory returned here will have had permissions of 0700 (rwx------) enforced when it was created. Of course, the permissions may have been altered since creation, so care still needs to be taken.

Returns : | An absolute path to the user-specific private directory that GNOME apps can use.

### gnome_user_accels_dir_get ()

    const char *        gnome_user_accels_dir_get           (void);

Retrieves the user-specific directory that stores the keyboard shortcut files for each GNOME app. Note that most applications should be using GConf for storing this information, but it may be necessary to use the `gnome_user_accels_dir_get()` directory for legacy applications.

Returns : | The absolute path to the directory.