diff options
Diffstat (limited to 'doc/tmpl')
| -rw-r--r-- | doc/tmpl/greeter.sgml | 151 | ||||
| -rw-r--r-- | doc/tmpl/language.sgml | 22 | ||||
| -rw-r--r-- | doc/tmpl/layout.sgml | 30 | ||||
| -rw-r--r-- | doc/tmpl/power.sgml | 90 | ||||
| -rw-r--r-- | doc/tmpl/session.sgml | 13 | ||||
| -rw-r--r-- | doc/tmpl/system.sgml | 31 | ||||
| -rw-r--r-- | doc/tmpl/user.sgml | 84 |
7 files changed, 260 insertions, 161 deletions
diff --git a/doc/tmpl/greeter.sgml b/doc/tmpl/greeter.sgml index fc6c4803..c3e2761e 100644 --- a/doc/tmpl/greeter.sgml +++ b/doc/tmpl/greeter.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMGreeter +Greeter Interface <!-- ##### SECTION Short_Description ##### --> -Manages connection to LightDM server and provides greeter functionality +Make a connection to the LightDM daemon and authenticate users <!-- ##### SECTION Long_Description ##### --> <para> @@ -31,7 +31,7 @@ int main () static void connected_cb (LightDMGreeter *greeter) { // Start authentication - lightdm_greeter_login_with_user_prompt (greeter); + lightdm_greeter_authenticate (greeter, NULL); } static void show_prompt_cb (LightDMGreeter *greeter, const char *text, LightDMPromptType type) @@ -177,69 +177,6 @@ static void quit_cb (LightDMGreeter *greeter) @Returns: -<!-- ##### FUNCTION lightdm_greeter_get_hostname ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_default_language ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_languages ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_layouts ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_layout ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_set_layout ##### --> -<para> - -</para> - -@greeter: -@layout: - - -<!-- ##### FUNCTION lightdm_greeter_get_sessions ##### --> -<para> - -</para> - -@greeter: -@Returns: - - <!-- ##### FUNCTION lightdm_greeter_get_default_session_hint ##### --> <para> @@ -322,7 +259,7 @@ static void quit_cb (LightDMGreeter *greeter) @Returns: -<!-- ##### FUNCTION lightdm_greeter_cancel_timed_login ##### --> +<!-- ##### FUNCTION lightdm_greeter_cancel_autologin ##### --> <para> </para> @@ -330,7 +267,7 @@ static void quit_cb (LightDMGreeter *greeter) @greeter: -<!-- ##### FUNCTION lightdm_greeter_login ##### --> +<!-- ##### FUNCTION lightdm_greeter_authenticate ##### --> <para> </para> @@ -339,15 +276,7 @@ static void quit_cb (LightDMGreeter *greeter) @username: -<!-- ##### FUNCTION lightdm_greeter_login_with_user_prompt ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_login_as_guest ##### --> +<!-- ##### FUNCTION lightdm_greeter_authenticate_as_guest ##### --> <para> </para> @@ -416,71 +345,3 @@ static void quit_cb (LightDMGreeter *greeter) @greeter: -<!-- ##### FUNCTION lightdm_greeter_get_can_suspend ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_suspend ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_get_can_hibernate ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_hibernate ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_get_can_restart ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_restart ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_get_can_shutdown ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_shutdown ##### --> -<para> - -</para> - -@greeter: - - diff --git a/doc/tmpl/language.sgml b/doc/tmpl/language.sgml index c78ffc5d..e8f7269b 100644 --- a/doc/tmpl/language.sgml +++ b/doc/tmpl/language.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMLanguage +Languages <!-- ##### SECTION Short_Description ##### --> -Information about an available language +Get information on available languges <!-- ##### SECTION Long_Description ##### --> <para> @@ -20,6 +20,24 @@ Information about an available language <!-- ##### SECTION Image ##### --> +<!-- ##### FUNCTION lightdm_get_languages ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_get_language ##### --> +<para> + +</para> + +@void: +@Returns: + + <!-- ##### FUNCTION lightdm_language_get_code ##### --> <para> diff --git a/doc/tmpl/layout.sgml b/doc/tmpl/layout.sgml index 5dc905c6..91db412b 100644 --- a/doc/tmpl/layout.sgml +++ b/doc/tmpl/layout.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMLayout +Keyboard Layouts <!-- ##### SECTION Short_Description ##### --> -Information about an available keyboard layout +Control the keyboard layout <!-- ##### SECTION Long_Description ##### --> <para> @@ -20,6 +20,32 @@ Information about an available keyboard layout <!-- ##### SECTION Image ##### --> +<!-- ##### FUNCTION lightdm_get_layouts ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_get_layout ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_set_layout ##### --> +<para> + +</para> + +@layout: + + <!-- ##### FUNCTION lightdm_layout_get_name ##### --> <para> diff --git a/doc/tmpl/power.sgml b/doc/tmpl/power.sgml new file mode 100644 index 00000000..2d1f5ff5 --- /dev/null +++ b/doc/tmpl/power.sgml @@ -0,0 +1,90 @@ +<!-- ##### SECTION Title ##### --> +Power Management + +<!-- ##### SECTION Short_Description ##### --> +Shutdown, restart, sleep the system + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION lightdm_get_can_suspend ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_suspend ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION lightdm_get_can_hibernate ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_hibernate ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION lightdm_get_can_restart ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_restart ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION lightdm_get_can_shutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_shutdown ##### --> +<para> + +</para> + +@void: + + diff --git a/doc/tmpl/session.sgml b/doc/tmpl/session.sgml index 7fe247c7..96f850ba 100644 --- a/doc/tmpl/session.sgml +++ b/doc/tmpl/session.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMSession +User Sessions <!-- ##### SECTION Short_Description ##### --> -Information about an available session +Choose the session to use <!-- ##### SECTION Long_Description ##### --> <para> @@ -20,6 +20,15 @@ Object containing information about a session type. #LightDMSession objects are <!-- ##### SECTION Image ##### --> +<!-- ##### FUNCTION lightdm_get_sessions ##### --> +<para> + +</para> + +@void: +@Returns: + + <!-- ##### FUNCTION lightdm_session_get_key ##### --> <para> diff --git a/doc/tmpl/system.sgml b/doc/tmpl/system.sgml new file mode 100644 index 00000000..c8cdb54c --- /dev/null +++ b/doc/tmpl/system.sgml @@ -0,0 +1,31 @@ +<!-- ##### SECTION Title ##### --> +System Information + +<!-- ##### SECTION Short_Description ##### --> +Get system infomation + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION lightdm_get_hostname ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/doc/tmpl/user.sgml b/doc/tmpl/user.sgml index c5aa4750..515d2ba2 100644 --- a/doc/tmpl/user.sgml +++ b/doc/tmpl/user.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMUser +User Accounts <!-- ##### SECTION Short_Description ##### --> -Information about a user account +Get information on user accounts on this system <!-- ##### SECTION Long_Description ##### --> <para> @@ -44,7 +44,7 @@ A user has the following properties: @user: -<!-- ##### FUNCTION lightdm_user_get_name ##### --> +<!-- ##### FUNCTION lightdm_user_get_display_name ##### --> <para> </para> @@ -53,7 +53,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_real_name ##### --> +<!-- ##### FUNCTION lightdm_user_get_home_directory ##### --> <para> </para> @@ -62,7 +62,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_display_name ##### --> +<!-- ##### FUNCTION lightdm_user_get_image ##### --> <para> </para> @@ -71,7 +71,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_home_directory ##### --> +<!-- ##### FUNCTION lightdm_user_get_language ##### --> <para> </para> @@ -80,7 +80,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_image ##### --> +<!-- ##### FUNCTION lightdm_user_get_layout ##### --> <para> </para> @@ -89,7 +89,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_language ##### --> +<!-- ##### FUNCTION lightdm_user_get_logged_in ##### --> <para> </para> @@ -98,7 +98,16 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_layout ##### --> +<!-- ##### FUNCTION lightdm_user_get_name ##### --> +<para> + +</para> + +@user: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_get_real_name ##### --> <para> </para> @@ -116,12 +125,67 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_logged_in ##### --> +<!-- ##### USER_FUNCTION user_added ##### --> +<para> + +</para> + +@user_list: +@user: + + +<!-- ##### USER_FUNCTION user_changed ##### --> <para> </para> +@user_list: @user: + + +<!-- ##### USER_FUNCTION user_removed ##### --> +<para> + +</para> + +@user_list: +@user: + + +<!-- ##### FUNCTION lightdm_user_list_get_instance ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_list_get_length ##### --> +<para> + +</para> + +@user_list: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_list_get_user_by_name ##### --> +<para> + +</para> + +@user_list: +@username: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_list_get_users ##### --> +<para> + +</para> + +@user_list: @Returns: |