gksu_context_new ()

GksuContext *
gksu_context_new (void);

This function should be used when creating a new GksuContext to pass to gksu_su_full or gksu_sudo_full. The GksuContext must be freed with gksu_context_free.

gksu_context_set_user ()

void
gksu_context_set_user (GksuContext *context,
                       gchar *username);

Sets up what user the command will be run as. The default is root, but you can run the command as any user.

gksu_context_get_user ()

const gchar *
gksu_context_get_user (GksuContext *context);

Gets the user the command will be run as, as set by gksu_context_set_user.

gksu_context_set_command ()

void
gksu_context_set_command (GksuContext *context,
                          gchar *command);

Sets up what command will run with the target user.

gksu_context_get_command ()

const gchar *
gksu_context_get_command (GksuContext *context);

Gets the command that will be run, as set by gksu_context_set_command.

gksu_context_set_keep_env ()

void
gksu_context_set_keep_env (GksuContext *context,
                           gboolean value);

Should the environment be kept as it is? Defaults to TRUE. Notice that setting this to FALSE may cause the X authorization stuff to fail.

gksu_context_get_keep_env ()

gboolean
gksu_context_get_keep_env (GksuContext *context);

Finds out if the environment in which the program will be run will be reset.

gksu_context_get_description ()

gchar *
gksu_context_get_description (GksuContext *context);

Get the description that the window will have when the default function for requesting the password is called.

gksu_context_set_description ()

void
gksu_context_set_description (GksuContext *context,
                              gchar *description);

Set the nice name for the action that is being run that the window that asks for the password will have. This is only meant to be used if the default window is used, of course.

gksu_context_set_message ()

void
gksu_context_set_message (GksuContext *context,
                          gchar *message);

Set the message that the window that asks for the password will have. This is only meant to be used if the default window is used, of course.

gksu_context_get_message ()

gchar *
gksu_context_get_message (GksuContext *context);

Get the message that the window will have when the default function for requesting the password is called.

gksu_context_set_login_shell ()

void
gksu_context_set_login_shell (GksuContext *context,
                              gboolean value);

Should the shell in which the command will be run be a login shell?

gksu_context_get_login_shell ()

gboolean
gksu_context_get_login_shell (GksuContext *context);

Finds out if the shell created by the underlying su process will be a login shell.

gksu_context_set_grab ()

void
gksu_context_set_grab (GksuContext *context,
                       gboolean value);

gksu_context_get_grab ()

gboolean
gksu_context_get_grab (GksuContext *context);

Returns TRUE if gksu has been asked to do a grab on keyboard and mouse when asking for the password.

gksu_context_set_debug ()

void
gksu_context_set_debug (GksuContext *context,
                        gboolean value);

Set up if debuging information should be printed.

gksu_context_get_debug ()

gboolean
gksu_context_get_debug (GksuContext *context);

Finds out if the library is configured to print debuging information.

gksu_context_free ()

void
gksu_context_free (GksuContext *context);

Frees the given GksuContext.

gksu_run ()

gboolean
gksu_run (gchar *command_line,
          GError **error);

This function is a wrapper for gksu_sudo/gksu_su. It will call one of them, depending on the GConf key that defines whether the default behavior for gksu is su or sudo mode. This is the recommended way of using the library functionality.

gksu_run_full ()

gboolean
gksu_run_full (GksuContext *context,
               GksuAskPassFunc ask_pass,
               gpointer ask_pass_data,
               GksuPassNotNeededFunc pass_not_needed,
               gpointer pass_not_needed_data,
               GError **error);

This is a compatibility shim over gksu_run_fuller, which, for compatibility reasons, lacks the 'exit_status' argument.

gksu_su ()

gboolean
gksu_su (gchar *command_line,
         GError **error);

This function is a wrapper for gksu_su_run_full. It will call it without giving the callback functions, which leads to the standard ones being called. A simple GksuContext is created to hold the user name and the command.

gksu_su_full ()

gboolean
gksu_su_full (GksuContext *context,
              GksuAskPassFunc ask_pass,
              gpointer ask_pass_data,
              GksuPassNotNeededFunc pass_not_needed,
              gpointer pass_not_needed_data,
              GError **error);

This is a compatibility shim over gksu_su_fuller, which, for compatibility reasons, lacks the 'exit_status' argument. You should check the documentation for gksu_su_fuller for information about the arguments.

gksu_sudo ()

gboolean
gksu_sudo (gchar *command_line,
           GError **error);

This function is a wrapper for gksu_sudo_run_full. It will call it without giving the callback functions, which leads to the standard ones being called. A simple GksuContext is created to hold the user name and the command.

gksu_sudo_full ()

gboolean
gksu_sudo_full (GksuContext *context,
                GksuAskPassFunc ask_pass,
                gpointer ask_pass_data,
                GksuPassNotNeededFunc pass_not_needed,
                gpointer pass_not_needed_data,
                GError **error);

This is a compatibility shim over gksu_sudo_fuller, which, for compatibility reasons, lacks the 'exit_status' argument. You should check the documentation for gksu_sudo_fuller for information about the arguments.

gksu_ask_password ()

gchar *
gksu_ask_password (GError **error);

This function uses the gksu infra-structure to request for a password, but instead of passing it to su or sudo to run a command it simply returns the password. This is just a convenience wrapper for gksu_ask_password_full.

gksu_ask_password_full ()

gchar *
gksu_ask_password_full (GksuContext *context,
                        gchar *prompt,
                        GError **error);

This function uses the gksu infra-structure to request for a password, but instead of passing it to su or sudo to run a command it simply returns the password.

enum GksuError