← Back to branch summary

~ubuntu-branches/ubuntu/wily/libuser/wily

« back to all changes in this revision

Viewing changes to docs/reference/xml/user.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ghe Rivero
  • Date: 2008-05-02 16:01:50 UTC
  • mfrom: (1.2.1 upstream) (7 intrepid)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20080502160150-cq4ayxgq4etkecut
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/user.xml
1
1
<refentry id="libuser-user">
2
2
<refmeta>
3
 
<refentrytitle id="top_of_page">user</refentrytitle>
 
3
<refentrytitle role="top_of_page">user</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>LIBUSER Library</refmiscinfo>
6
6
</refmeta>
13
13
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
14
</refnamediv>
15
15
 
16
 
<refsynopsisdiv id="synopsis">
17
 
<title id="synopsis.title">Synopsis</title>
 
16
<refsynopsisdiv role="synopsis">
 
17
<title role="synopsis.title">Synopsis</title>
18
18
 
19
19
<synopsis>
20
20
 
21
21
 
22
22
 
23
 
<link linkend="lu-context-t">lu_context_t</link>* <link linkend="lu-start">lu_start</link>                      (const <link linkend="char">char</link> *authname,
24
 
                                             <link linkend="lu-entity-type-t">lu_entity_type_t</link> auth_type,
25
 
                                             const <link linkend="char">char</link> *modules,
26
 
                                             const <link linkend="char">char</link> *create_modules,
27
 
                                             <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
28
 
                                             <link linkend="gpointer">gpointer</link> callback_data,
29
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
30
 
<link linkend="void">void</link>        <link linkend="lu-end">lu_end</link>                          (<link linkend="lu-context-t">lu_context_t</link> *context);
31
 
<link linkend="void">void</link>        <link linkend="lu-set-prompter">lu_set_prompter</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
32
 
                                             <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
33
 
                                             <link linkend="gpointer">gpointer</link> callback_data);
34
 
<link linkend="void">void</link>        <link linkend="lu-get-prompter">lu_get_prompter</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
35
 
                                             <link linkend="lu-prompt-fn">lu_prompt_fn</link> **prompter,
36
 
                                             <link linkend="gpointer">gpointer</link> *callback_data);
37
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-set-modules">lu_set_modules</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context,
38
 
                                             const <link linkend="char">char</link> *list,
39
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
40
 
const <link linkend="char">char</link>* <link linkend="lu-get-modules">lu_get_modules</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context);
41
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-uses-elevated-privileges">lu_uses_elevated_privileges</link>     (<link linkend="lu-context-t">lu_context_t</link> *context);
42
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-lookup-name">lu_user_lookup_name</link>             (<link linkend="lu-context-t">lu_context_t</link> *context,
43
 
                                             const <link linkend="char">char</link> *name,
44
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
45
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
46
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-lookup-id">lu_user_lookup_id</link>               (<link linkend="lu-context-t">lu_context_t</link> *context,
47
 
                                             <link linkend="uid-t">uid_t</link> uid,
48
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
49
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
50
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-default">lu_user_default</link>                 (<link linkend="lu-context-t">lu_context_t</link> *ctx,
51
 
                                             const <link linkend="char">char</link> *name,
52
 
                                             <link linkend="gboolean">gboolean</link> system_account,
53
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent);
54
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-add">lu_user_add</link>                     (<link linkend="lu-context-t">lu_context_t</link> *context,
55
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
56
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
57
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-modify">lu_user_modify</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context,
58
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
59
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
60
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-delete">lu_user_delete</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context,
61
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
62
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
63
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-setpass">lu_user_setpass</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
64
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
65
 
                                             const <link linkend="char">char</link> *newpass,
66
 
                                             <link linkend="gboolean">gboolean</link> crypted,
67
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
68
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-removepass">lu_user_removepass</link>              (<link linkend="lu-context-t">lu_context_t</link> *context,
69
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
70
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
71
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-lock">lu_user_lock</link>                    (<link linkend="lu-context-t">lu_context_t</link> *context,
72
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
73
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
74
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-unlock">lu_user_unlock</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context,
75
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
76
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
77
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-unlock-nonempty">lu_user_unlock_nonempty</link>         (<link linkend="lu-context-t">lu_context_t</link> *context,
78
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
79
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
80
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-user-islocked">lu_user_islocked</link>                (<link linkend="lu-context-t">lu_context_t</link> *context,
81
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
82
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
83
 
<link linkend="GValueArray">GValueArray</link>* <link linkend="lu-users-enumerate">lu_users_enumerate</link>             (<link linkend="lu-context-t">lu_context_t</link> *context,
84
 
                                             const <link linkend="char">char</link> *pattern,
85
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
86
 
<link linkend="GValueArray">GValueArray</link>* <link linkend="lu-users-enumerate-by-group">lu_users_enumerate_by_group</link>    (<link linkend="lu-context-t">lu_context_t</link> *context,
87
 
                                             const <link linkend="char">char</link> *group,
88
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
89
 
<link linkend="GPtrArray">GPtrArray</link>*  <link linkend="lu-users-enumerate-full">lu_users_enumerate_full</link>         (<link linkend="lu-context-t">lu_context_t</link> *context,
90
 
                                             const <link linkend="char">char</link> *pattern,
91
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
92
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-lookup-name">lu_group_lookup_name</link>            (<link linkend="lu-context-t">lu_context_t</link> *context,
93
 
                                             const <link linkend="char">char</link> *name,
94
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
95
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
96
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-lookup-id">lu_group_lookup_id</link>              (<link linkend="lu-context-t">lu_context_t</link> *context,
97
 
                                             <link linkend="gid-t">gid_t</link> gid,
98
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
99
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
100
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-default">lu_group_default</link>                (<link linkend="lu-context-t">lu_context_t</link> *ctx,
101
 
                                             const <link linkend="char">char</link> *name,
102
 
                                             <link linkend="gboolean">gboolean</link> system_account,
103
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent);
104
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-add">lu_group_add</link>                    (<link linkend="lu-context-t">lu_context_t</link> *context,
105
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
106
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
107
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-modify">lu_group_modify</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
108
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
109
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
110
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-delete">lu_group_delete</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
111
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
112
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
113
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-setpass">lu_group_setpass</link>                (<link linkend="lu-context-t">lu_context_t</link> *context,
114
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
115
 
                                             const <link linkend="char">char</link> *newpass,
116
 
                                             <link linkend="gboolean">gboolean</link> crypted,
117
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
118
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-removepass">lu_group_removepass</link>             (<link linkend="lu-context-t">lu_context_t</link> *context,
119
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
120
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
121
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-lock">lu_group_lock</link>                   (<link linkend="lu-context-t">lu_context_t</link> *context,
122
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
123
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
124
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-unlock">lu_group_unlock</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
125
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
126
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
127
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-unlock-nonempty">lu_group_unlock_nonempty</link>        (<link linkend="lu-context-t">lu_context_t</link> *context,
128
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
129
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
130
 
<link linkend="gboolean">gboolean</link>    <link linkend="lu-group-islocked">lu_group_islocked</link>               (<link linkend="lu-context-t">lu_context_t</link> *context,
131
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
132
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
133
 
<link linkend="GValueArray">GValueArray</link>* <link linkend="lu-groups-enumerate">lu_groups_enumerate</link>            (<link linkend="lu-context-t">lu_context_t</link> *context,
134
 
                                             const <link linkend="char">char</link> *pattern,
135
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
136
 
<link linkend="GValueArray">GValueArray</link>* <link linkend="lu-groups-enumerate-by-user">lu_groups_enumerate_by_user</link>    (<link linkend="lu-context-t">lu_context_t</link> *context,
137
 
                                             const <link linkend="char">char</link> *user,
138
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
139
 
<link linkend="GPtrArray">GPtrArray</link>*  <link linkend="lu-groups-enumerate-full">lu_groups_enumerate_full</link>        (<link linkend="lu-context-t">lu_context_t</link> *context,
140
 
                                             const <link linkend="char">char</link> *pattern,
141
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);
 
23
<link linkend="lu-context-t">lu_context_t</link>*       <link linkend="lu-start">lu_start</link>                            (const <link linkend="char">char</link> *authname,
 
24
                                                         <link linkend="lu-entity-type-t">lu_entity_type_t</link> auth_type,
 
25
                                                         const <link linkend="char">char</link> *modules,
 
26
                                                         const <link linkend="char">char</link> *create_modules,
 
27
                                                         <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
 
28
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
29
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
30
<link linkend="void">void</link>                <link linkend="lu-end">lu_end</link>                              (<link linkend="lu-context-t">lu_context_t</link> *context);
 
31
<link linkend="void">void</link>                <link linkend="lu-set-prompter">lu_set_prompter</link>                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
32
                                                         <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
 
33
                                                         <link linkend="gpointer">gpointer</link> callback_data);
 
34
<link linkend="void">void</link>                <link linkend="lu-get-prompter">lu_get_prompter</link>                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
35
                                                         <link linkend="lu-prompt-fn">lu_prompt_fn</link> **prompter,
 
36
                                                         <link linkend="gpointer">gpointer</link> *callback_data);
 
37
<link linkend="gboolean">gboolean</link>            <link linkend="lu-set-modules">lu_set_modules</link>                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
38
                                                         const <link linkend="char">char</link> *list,
 
39
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
40
const <link linkend="char">char</link>*         <link linkend="lu-get-modules">lu_get_modules</link>                      (<link linkend="lu-context-t">lu_context_t</link> *context);
 
41
<link linkend="gboolean">gboolean</link>            <link linkend="lu-uses-elevated-privileges">lu_uses_elevated_privileges</link>         (<link linkend="lu-context-t">lu_context_t</link> *context);
 
42
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-lookup-name">lu_user_lookup_name</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
 
43
                                                         const <link linkend="char">char</link> *name,
 
44
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
45
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
46
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-lookup-id">lu_user_lookup_id</link>                   (<link linkend="lu-context-t">lu_context_t</link> *context,
 
47
                                                         <link linkend="uid-t">uid_t</link> uid,
 
48
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
49
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
50
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-default">lu_user_default</link>                     (<link linkend="lu-context-t">lu_context_t</link> *ctx,
 
51
                                                         const <link linkend="char">char</link> *name,
 
52
                                                         <link linkend="gboolean">gboolean</link> system_account,
 
53
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent);
 
54
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-add">lu_user_add</link>                         (<link linkend="lu-context-t">lu_context_t</link> *context,
 
55
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
56
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
57
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-modify">lu_user_modify</link>                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
58
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
59
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
60
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-delete">lu_user_delete</link>                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
61
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
62
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
63
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-setpass">lu_user_setpass</link>                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
64
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
65
                                                         const <link linkend="char">char</link> *newpass,
 
66
                                                         <link linkend="gboolean">gboolean</link> crypted,
 
67
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
68
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-removepass">lu_user_removepass</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context,
 
69
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
70
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
71
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-lock">lu_user_lock</link>                        (<link linkend="lu-context-t">lu_context_t</link> *context,
 
72
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
73
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
74
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-unlock">lu_user_unlock</link>                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
75
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
76
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
77
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-unlock-nonempty">lu_user_unlock_nonempty</link>             (<link linkend="lu-context-t">lu_context_t</link> *context,
 
78
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
79
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
80
<link linkend="gboolean">gboolean</link>            <link linkend="lu-user-islocked">lu_user_islocked</link>                    (<link linkend="lu-context-t">lu_context_t</link> *context,
 
81
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
82
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
83
<link linkend="GValueArray">GValueArray</link>*        <link linkend="lu-users-enumerate">lu_users_enumerate</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context,
 
84
                                                         const <link linkend="char">char</link> *pattern,
 
85
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
86
<link linkend="GValueArray">GValueArray</link>*        <link linkend="lu-users-enumerate-by-group">lu_users_enumerate_by_group</link>         (<link linkend="lu-context-t">lu_context_t</link> *context,
 
87
                                                         const <link linkend="char">char</link> *group,
 
88
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
89
<link linkend="GPtrArray">GPtrArray</link>*          <link linkend="lu-users-enumerate-full">lu_users_enumerate_full</link>             (<link linkend="lu-context-t">lu_context_t</link> *context,
 
90
                                                         const <link linkend="char">char</link> *pattern,
 
91
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
92
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-lookup-name">lu_group_lookup_name</link>                (<link linkend="lu-context-t">lu_context_t</link> *context,
 
93
                                                         const <link linkend="char">char</link> *name,
 
94
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
95
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
96
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-lookup-id">lu_group_lookup_id</link>                  (<link linkend="lu-context-t">lu_context_t</link> *context,
 
97
                                                         <link linkend="gid-t">gid_t</link> gid,
 
98
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
99
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
100
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-default">lu_group_default</link>                    (<link linkend="lu-context-t">lu_context_t</link> *ctx,
 
101
                                                         const <link linkend="char">char</link> *name,
 
102
                                                         <link linkend="gboolean">gboolean</link> system_account,
 
103
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent);
 
104
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-add">lu_group_add</link>                        (<link linkend="lu-context-t">lu_context_t</link> *context,
 
105
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
106
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
107
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-modify">lu_group_modify</link>                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
108
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
109
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
110
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-delete">lu_group_delete</link>                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
111
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
112
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
113
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-setpass">lu_group_setpass</link>                    (<link linkend="lu-context-t">lu_context_t</link> *context,
 
114
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
115
                                                         const <link linkend="char">char</link> *newpass,
 
116
                                                         <link linkend="gboolean">gboolean</link> crypted,
 
117
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
118
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-removepass">lu_group_removepass</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
 
119
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
120
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
121
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-lock">lu_group_lock</link>                       (<link linkend="lu-context-t">lu_context_t</link> *context,
 
122
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
123
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
124
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-unlock">lu_group_unlock</link>                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
125
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
126
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
127
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-unlock-nonempty">lu_group_unlock_nonempty</link>            (<link linkend="lu-context-t">lu_context_t</link> *context,
 
128
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
129
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
130
<link linkend="gboolean">gboolean</link>            <link linkend="lu-group-islocked">lu_group_islocked</link>                   (<link linkend="lu-context-t">lu_context_t</link> *context,
 
131
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
132
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
133
<link linkend="GValueArray">GValueArray</link>*        <link linkend="lu-groups-enumerate">lu_groups_enumerate</link>                 (<link linkend="lu-context-t">lu_context_t</link> *context,
 
134
                                                         const <link linkend="char">char</link> *pattern,
 
135
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
136
<link linkend="GValueArray">GValueArray</link>*        <link linkend="lu-groups-enumerate-by-user">lu_groups_enumerate_by_user</link>         (<link linkend="lu-context-t">lu_context_t</link> *context,
 
137
                                                         const <link linkend="char">char</link> *user,
 
138
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
 
139
<link linkend="GPtrArray">GPtrArray</link>*          <link linkend="lu-groups-enumerate-full">lu_groups_enumerate_full</link>            (<link linkend="lu-context-t">lu_context_t</link> *context,
 
140
                                                         const <link linkend="char">char</link> *pattern,
 
141
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);
142
142
</synopsis>
143
143
</refsynopsisdiv>
144
144
 
150
150
 
151
151
 
152
152
 
153
 
<refsect1 id="desc">
154
 
<title id="desc.title">Description</title>
 
153
<refsect1 role="desc">
 
154
<title role="desc.title">Description</title>
155
155
<para>
156
156
 
157
157
user.h contains declarations for functions which start up and shut down the
161
161
</para>
162
162
</refsect1>
163
163
 
164
 
<refsect1 id="details">
165
 
<title id="details.title">Details</title>
 
164
<refsect1 role="details">
 
165
<title role="details.title">Details</title>
166
166
<refsect2>
167
167
<title><anchor id="lu-start" role="function"/>lu_start ()</title>
168
 
<indexterm><primary>lu_start</primary></indexterm><programlisting><link linkend="lu-context-t">lu_context_t</link>* lu_start                      (const <link linkend="char">char</link> *authname,
169
 
                                             <link linkend="lu-entity-type-t">lu_entity_type_t</link> auth_type,
170
 
                                             const <link linkend="char">char</link> *modules,
171
 
                                             const <link linkend="char">char</link> *create_modules,
172
 
                                             <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
173
 
                                             <link linkend="gpointer">gpointer</link> callback_data,
174
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
168
<indexterm><primary>lu_start</primary></indexterm><programlisting><link linkend="lu-context-t">lu_context_t</link>*       lu_start                            (const <link linkend="char">char</link> *authname,
 
169
                                                         <link linkend="lu-entity-type-t">lu_entity_type_t</link> auth_type,
 
170
                                                         const <link linkend="char">char</link> *modules,
 
171
                                                         const <link linkend="char">char</link> *create_modules,
 
172
                                                         <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
 
173
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
174
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
175
175
<para>
176
176
Initializes the libuser library.
177
177
</para><variablelist role="params">
206
206
</variablelist></refsect2>
207
207
<refsect2>
208
208
<title><anchor id="lu-end" role="function"/>lu_end ()</title>
209
 
<indexterm><primary>lu_end</primary></indexterm><programlisting><link linkend="void">void</link>        lu_end                          (<link linkend="lu-context-t">lu_context_t</link> *context);</programlisting>
 
209
<indexterm><primary>lu_end</primary></indexterm><programlisting><link linkend="void">void</link>                lu_end                              (<link linkend="lu-context-t">lu_context_t</link> *context);</programlisting>
210
210
<para>
211
211
Destroys a libuser library context
212
212
</para><variablelist role="params">
218
218
</variablelist></refsect2>
219
219
<refsect2>
220
220
<title><anchor id="lu-set-prompter" role="function"/>lu_set_prompter ()</title>
221
 
<indexterm><primary>lu_set_prompter</primary></indexterm><programlisting><link linkend="void">void</link>        lu_set_prompter                 (<link linkend="lu-context-t">lu_context_t</link> *context,
222
 
                                             <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
223
 
                                             <link linkend="gpointer">gpointer</link> callback_data);</programlisting>
 
221
<indexterm><primary>lu_set_prompter</primary></indexterm><programlisting><link linkend="void">void</link>                lu_set_prompter                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
222
                                                         <link linkend="lu-prompt-fn">lu_prompt_fn</link> *prompter,
 
223
                                                         <link linkend="gpointer">gpointer</link> callback_data);</programlisting>
224
224
<para>
225
225
Changes the prompter function in a context
226
226
</para><variablelist role="params">
238
238
</variablelist></refsect2>
239
239
<refsect2>
240
240
<title><anchor id="lu-get-prompter" role="function"/>lu_get_prompter ()</title>
241
 
<indexterm><primary>lu_get_prompter</primary></indexterm><programlisting><link linkend="void">void</link>        lu_get_prompter                 (<link linkend="lu-context-t">lu_context_t</link> *context,
242
 
                                             <link linkend="lu-prompt-fn">lu_prompt_fn</link> **prompter,
243
 
                                             <link linkend="gpointer">gpointer</link> *callback_data);</programlisting>
 
241
<indexterm><primary>lu_get_prompter</primary></indexterm><programlisting><link linkend="void">void</link>                lu_get_prompter                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
242
                                                         <link linkend="lu-prompt-fn">lu_prompt_fn</link> **prompter,
 
243
                                                         <link linkend="gpointer">gpointer</link> *callback_data);</programlisting>
244
244
<para>
245
245
Gets current prompter function from a context
246
246
</para><variablelist role="params">
260
260
</variablelist></refsect2>
261
261
<refsect2>
262
262
<title><anchor id="lu-set-modules" role="function"/>lu_set_modules ()</title>
263
 
<indexterm><primary>lu_set_modules</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_set_modules                  (<link linkend="lu-context-t">lu_context_t</link> *context,
264
 
                                             const <link linkend="char">char</link> *list,
265
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
263
<indexterm><primary>lu_set_modules</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_set_modules                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
264
                                                         const <link linkend="char">char</link> *list,
 
265
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
266
266
<para>
267
267
Replaces the current set of modules for queries in <parameter>context</parameter> to <parameter>list</parameter>.
268
268
</para><variablelist role="params">
282
282
</variablelist></refsect2>
283
283
<refsect2>
284
284
<title><anchor id="lu-get-modules" role="function"/>lu_get_modules ()</title>
285
 
<indexterm><primary>lu_get_modules</primary></indexterm><programlisting>const <link linkend="char">char</link>* lu_get_modules                  (<link linkend="lu-context-t">lu_context_t</link> *context);</programlisting>
 
285
<indexterm><primary>lu_get_modules</primary></indexterm><programlisting>const <link linkend="char">char</link>*         lu_get_modules                      (<link linkend="lu-context-t">lu_context_t</link> *context);</programlisting>
286
286
<para>
287
287
Returns a list of modules for queries in <parameter>context</parameter>.
288
288
</para><variablelist role="params">
297
297
</variablelist></refsect2>
298
298
<refsect2>
299
299
<title><anchor id="lu-uses-elevated-privileges" role="function"/>lu_uses_elevated_privileges ()</title>
300
 
<indexterm><primary>lu_uses_elevated_privileges</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_uses_elevated_privileges     (<link linkend="lu-context-t">lu_context_t</link> *context);</programlisting>
 
300
<indexterm><primary>lu_uses_elevated_privileges</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_uses_elevated_privileges         (<link linkend="lu-context-t">lu_context_t</link> *context);</programlisting>
301
301
<para>
302
302
Checks if any module uses elevated privileges (e.g. modifies files that
303
303
normal users can't modify).
312
312
</variablelist></refsect2>
313
313
<refsect2>
314
314
<title><anchor id="lu-user-lookup-name" role="function"/>lu_user_lookup_name ()</title>
315
 
<indexterm><primary>lu_user_lookup_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_lookup_name             (<link linkend="lu-context-t">lu_context_t</link> *context,
316
 
                                             const <link linkend="char">char</link> *name,
317
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
318
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
315
<indexterm><primary>lu_user_lookup_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_lookup_name                 (<link linkend="lu-context-t">lu_context_t</link> *context,
 
316
                                                         const <link linkend="char">char</link> *name,
 
317
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
318
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
319
319
<para>
320
320
Looks up an user by name.
321
321
</para><variablelist role="params">
338
338
</variablelist></refsect2>
339
339
<refsect2>
340
340
<title><anchor id="lu-user-lookup-id" role="function"/>lu_user_lookup_id ()</title>
341
 
<indexterm><primary>lu_user_lookup_id</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_lookup_id               (<link linkend="lu-context-t">lu_context_t</link> *context,
342
 
                                             <link linkend="uid-t">uid_t</link> uid,
343
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
344
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
341
<indexterm><primary>lu_user_lookup_id</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_lookup_id                   (<link linkend="lu-context-t">lu_context_t</link> *context,
 
342
                                                         <link linkend="uid-t">uid_t</link> uid,
 
343
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
344
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
345
345
<para>
346
346
Looks up an user by UID.
347
347
</para><variablelist role="params">
364
364
</variablelist></refsect2>
365
365
<refsect2>
366
366
<title><anchor id="lu-user-default" role="function"/>lu_user_default ()</title>
367
 
<indexterm><primary>lu_user_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_default                 (<link linkend="lu-context-t">lu_context_t</link> *ctx,
368
 
                                             const <link linkend="char">char</link> *name,
369
 
                                             <link linkend="gboolean">gboolean</link> system_account,
370
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent);</programlisting>
 
367
<indexterm><primary>lu_user_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_default                     (<link linkend="lu-context-t">lu_context_t</link> *ctx,
 
368
                                                         const <link linkend="char">char</link> *name,
 
369
                                                         <link linkend="gboolean">gboolean</link> system_account,
 
370
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent);</programlisting>
371
371
<para>
372
372
Fills out an user entity as specified by the config file and modules
373
373
to prepare for creation of the user.
391
391
</variablelist></refsect2>
392
392
<refsect2>
393
393
<title><anchor id="lu-user-add" role="function"/>lu_user_add ()</title>
394
 
<indexterm><primary>lu_user_add</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_add                     (<link linkend="lu-context-t">lu_context_t</link> *context,
395
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
396
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
394
<indexterm><primary>lu_user_add</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_add                         (<link linkend="lu-context-t">lu_context_t</link> *context,
 
395
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
396
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
397
397
<para>
398
398
Creates an user in all modules specified for entity creation.
399
399
</para><variablelist role="params">
413
413
</variablelist></refsect2>
414
414
<refsect2>
415
415
<title><anchor id="lu-user-modify" role="function"/>lu_user_modify ()</title>
416
 
<indexterm><primary>lu_user_modify</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_modify                  (<link linkend="lu-context-t">lu_context_t</link> *context,
417
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
418
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
416
<indexterm><primary>lu_user_modify</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_modify                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
417
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
418
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
419
419
<para>
420
420
Modifies an user entity.
421
421
</para><variablelist role="params">
436
436
</variablelist></refsect2>
437
437
<refsect2>
438
438
<title><anchor id="lu-user-delete" role="function"/>lu_user_delete ()</title>
439
 
<indexterm><primary>lu_user_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_delete                  (<link linkend="lu-context-t">lu_context_t</link> *context,
440
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
441
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
439
<indexterm><primary>lu_user_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_delete                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
440
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
441
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
442
442
<para>
443
443
Deletes an user.
444
444
</para><variablelist role="params">
458
458
</variablelist></refsect2>
459
459
<refsect2>
460
460
<title><anchor id="lu-user-setpass" role="function"/>lu_user_setpass ()</title>
461
 
<indexterm><primary>lu_user_setpass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_setpass                 (<link linkend="lu-context-t">lu_context_t</link> *context,
462
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
463
 
                                             const <link linkend="char">char</link> *newpass,
464
 
                                             <link linkend="gboolean">gboolean</link> crypted,
465
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
461
<indexterm><primary>lu_user_setpass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_setpass                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
462
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
463
                                                         const <link linkend="char">char</link> *newpass,
 
464
                                                         <link linkend="gboolean">gboolean</link> crypted,
 
465
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
466
466
<para>
467
467
Changes an user's password.
468
468
</para><variablelist role="params">
489
489
</variablelist></refsect2>
490
490
<refsect2>
491
491
<title><anchor id="lu-user-removepass" role="function"/>lu_user_removepass ()</title>
492
 
<indexterm><primary>lu_user_removepass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_removepass              (<link linkend="lu-context-t">lu_context_t</link> *context,
493
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
494
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
492
<indexterm><primary>lu_user_removepass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_removepass                  (<link linkend="lu-context-t">lu_context_t</link> *context,
 
493
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
494
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
495
495
<para>
496
496
Changes an user's password to an empty string.
497
497
</para><variablelist role="params">
512
512
</variablelist></refsect2>
513
513
<refsect2>
514
514
<title><anchor id="lu-user-lock" role="function"/>lu_user_lock ()</title>
515
 
<indexterm><primary>lu_user_lock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_lock                    (<link linkend="lu-context-t">lu_context_t</link> *context,
516
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
517
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
515
<indexterm><primary>lu_user_lock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_lock                        (<link linkend="lu-context-t">lu_context_t</link> *context,
 
516
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
517
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
518
518
<para>
519
519
Locks an user account.
520
520
</para><variablelist role="params">
535
535
</variablelist></refsect2>
536
536
<refsect2>
537
537
<title><anchor id="lu-user-unlock" role="function"/>lu_user_unlock ()</title>
538
 
<indexterm><primary>lu_user_unlock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_unlock                  (<link linkend="lu-context-t">lu_context_t</link> *context,
539
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
540
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
538
<indexterm><primary>lu_user_unlock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_unlock                      (<link linkend="lu-context-t">lu_context_t</link> *context,
 
539
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
540
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
541
541
<para>
542
542
Unlocks an user account.
543
543
</para><variablelist role="params">
558
558
</variablelist></refsect2>
559
559
<refsect2>
560
560
<title><anchor id="lu-user-unlock-nonempty" role="function"/>lu_user_unlock_nonempty ()</title>
561
 
<indexterm><primary>lu_user_unlock_nonempty</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_unlock_nonempty         (<link linkend="lu-context-t">lu_context_t</link> *context,
562
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
563
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
561
<indexterm><primary>lu_user_unlock_nonempty</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_unlock_nonempty             (<link linkend="lu-context-t">lu_context_t</link> *context,
 
562
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
563
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
564
564
<para>
565
565
Unlocks an user account.  If unlocking the account would result in an empty
566
566
password field, it fails with <link linkend="lu-error-unlock-empty"><literal>lu_error_unlock_empty</literal></link>.  Note that the
583
583
</variablelist></refsect2>
584
584
<refsect2>
585
585
<title><anchor id="lu-user-islocked" role="function"/>lu_user_islocked ()</title>
586
 
<indexterm><primary>lu_user_islocked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_user_islocked                (<link linkend="lu-context-t">lu_context_t</link> *context,
587
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
588
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
586
<indexterm><primary>lu_user_islocked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_user_islocked                    (<link linkend="lu-context-t">lu_context_t</link> *context,
 
587
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
588
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
589
589
<para>
590
590
Checks if an user account is locked.
591
591
</para><variablelist role="params">
605
605
</variablelist></refsect2>
606
606
<refsect2>
607
607
<title><anchor id="lu-users-enumerate" role="function"/>lu_users_enumerate ()</title>
608
 
<indexterm><primary>lu_users_enumerate</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>* lu_users_enumerate             (<link linkend="lu-context-t">lu_context_t</link> *context,
609
 
                                             const <link linkend="char">char</link> *pattern,
610
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
608
<indexterm><primary>lu_users_enumerate</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>*        lu_users_enumerate                  (<link linkend="lu-context-t">lu_context_t</link> *context,
 
609
                                                         const <link linkend="char">char</link> *pattern,
 
610
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
611
611
<para>
612
612
Returns a list of all users matching a pattern.
613
613
</para><variablelist role="params">
628
628
</variablelist></refsect2>
629
629
<refsect2>
630
630
<title><anchor id="lu-users-enumerate-by-group" role="function"/>lu_users_enumerate_by_group ()</title>
631
 
<indexterm><primary>lu_users_enumerate_by_group</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>* lu_users_enumerate_by_group    (<link linkend="lu-context-t">lu_context_t</link> *context,
632
 
                                             const <link linkend="char">char</link> *group,
633
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
631
<indexterm><primary>lu_users_enumerate_by_group</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>*        lu_users_enumerate_by_group         (<link linkend="lu-context-t">lu_context_t</link> *context,
 
632
                                                         const <link linkend="char">char</link> *group,
 
633
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
634
634
<para>
635
635
Returns a list of all members of a group <parameter>group</parameter>.
636
636
</para><variablelist role="params">
651
651
</variablelist></refsect2>
652
652
<refsect2>
653
653
<title><anchor id="lu-users-enumerate-full" role="function"/>lu_users_enumerate_full ()</title>
654
 
<indexterm><primary>lu_users_enumerate_full</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*  lu_users_enumerate_full         (<link linkend="lu-context-t">lu_context_t</link> *context,
655
 
                                             const <link linkend="char">char</link> *pattern,
656
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
654
<indexterm><primary>lu_users_enumerate_full</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*          lu_users_enumerate_full             (<link linkend="lu-context-t">lu_context_t</link> *context,
 
655
                                                         const <link linkend="char">char</link> *pattern,
 
656
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
657
657
<para>
658
658
Returns a list of entities, one for each user matching a pattern.
659
659
</para><variablelist role="params">
674
674
</variablelist></refsect2>
675
675
<refsect2>
676
676
<title><anchor id="lu-group-lookup-name" role="function"/>lu_group_lookup_name ()</title>
677
 
<indexterm><primary>lu_group_lookup_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_lookup_name            (<link linkend="lu-context-t">lu_context_t</link> *context,
678
 
                                             const <link linkend="char">char</link> *name,
679
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
680
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
677
<indexterm><primary>lu_group_lookup_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_lookup_name                (<link linkend="lu-context-t">lu_context_t</link> *context,
 
678
                                                         const <link linkend="char">char</link> *name,
 
679
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
680
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
681
681
<para>
682
682
Looks up a group by name.
683
683
</para><variablelist role="params">
700
700
</variablelist></refsect2>
701
701
<refsect2>
702
702
<title><anchor id="lu-group-lookup-id" role="function"/>lu_group_lookup_id ()</title>
703
 
<indexterm><primary>lu_group_lookup_id</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_lookup_id              (<link linkend="lu-context-t">lu_context_t</link> *context,
704
 
                                             <link linkend="gid-t">gid_t</link> gid,
705
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
706
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
703
<indexterm><primary>lu_group_lookup_id</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_lookup_id                  (<link linkend="lu-context-t">lu_context_t</link> *context,
 
704
                                                         <link linkend="gid-t">gid_t</link> gid,
 
705
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
706
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
707
707
<para>
708
708
Looks up a group by GID.
709
709
</para><variablelist role="params">
726
726
</variablelist></refsect2>
727
727
<refsect2>
728
728
<title><anchor id="lu-group-default" role="function"/>lu_group_default ()</title>
729
 
<indexterm><primary>lu_group_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_default                (<link linkend="lu-context-t">lu_context_t</link> *ctx,
730
 
                                             const <link linkend="char">char</link> *name,
731
 
                                             <link linkend="gboolean">gboolean</link> system_account,
732
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent);</programlisting>
 
729
<indexterm><primary>lu_group_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_default                    (<link linkend="lu-context-t">lu_context_t</link> *ctx,
 
730
                                                         const <link linkend="char">char</link> *name,
 
731
                                                         <link linkend="gboolean">gboolean</link> system_account,
 
732
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent);</programlisting>
733
733
<para>
734
734
Fills out a group entity as specified by the config file and modules
735
735
to prepare for creation of the group.
753
753
</variablelist></refsect2>
754
754
<refsect2>
755
755
<title><anchor id="lu-group-add" role="function"/>lu_group_add ()</title>
756
 
<indexterm><primary>lu_group_add</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_add                    (<link linkend="lu-context-t">lu_context_t</link> *context,
757
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
758
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
756
<indexterm><primary>lu_group_add</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_add                        (<link linkend="lu-context-t">lu_context_t</link> *context,
 
757
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
758
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
759
759
<para>
760
760
Creates a group in all modules specified for entity creation.
761
761
</para><variablelist role="params">
775
775
</variablelist></refsect2>
776
776
<refsect2>
777
777
<title><anchor id="lu-group-modify" role="function"/>lu_group_modify ()</title>
778
 
<indexterm><primary>lu_group_modify</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_modify                 (<link linkend="lu-context-t">lu_context_t</link> *context,
779
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
780
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
778
<indexterm><primary>lu_group_modify</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_modify                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
779
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
780
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
781
781
<para>
782
782
Modifies a group entity.
783
783
</para><variablelist role="params">
798
798
</variablelist></refsect2>
799
799
<refsect2>
800
800
<title><anchor id="lu-group-delete" role="function"/>lu_group_delete ()</title>
801
 
<indexterm><primary>lu_group_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_delete                 (<link linkend="lu-context-t">lu_context_t</link> *context,
802
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
803
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
801
<indexterm><primary>lu_group_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_delete                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
802
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
803
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
804
804
<para>
805
805
Deletes a group.
806
806
</para><variablelist role="params">
820
820
</variablelist></refsect2>
821
821
<refsect2>
822
822
<title><anchor id="lu-group-setpass" role="function"/>lu_group_setpass ()</title>
823
 
<indexterm><primary>lu_group_setpass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_setpass                (<link linkend="lu-context-t">lu_context_t</link> *context,
824
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
825
 
                                             const <link linkend="char">char</link> *newpass,
826
 
                                             <link linkend="gboolean">gboolean</link> crypted,
827
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
823
<indexterm><primary>lu_group_setpass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_setpass                    (<link linkend="lu-context-t">lu_context_t</link> *context,
 
824
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
825
                                                         const <link linkend="char">char</link> *newpass,
 
826
                                                         <link linkend="gboolean">gboolean</link> crypted,
 
827
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
828
828
<para>
829
829
Changes a group password.
830
830
</para><variablelist role="params">
851
851
</variablelist></refsect2>
852
852
<refsect2>
853
853
<title><anchor id="lu-group-removepass" role="function"/>lu_group_removepass ()</title>
854
 
<indexterm><primary>lu_group_removepass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_removepass             (<link linkend="lu-context-t">lu_context_t</link> *context,
855
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
856
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
854
<indexterm><primary>lu_group_removepass</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_removepass                 (<link linkend="lu-context-t">lu_context_t</link> *context,
 
855
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
856
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
857
857
<para>
858
858
Changes a group password to an empty string.
859
859
</para><variablelist role="params">
874
874
</variablelist></refsect2>
875
875
<refsect2>
876
876
<title><anchor id="lu-group-lock" role="function"/>lu_group_lock ()</title>
877
 
<indexterm><primary>lu_group_lock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_lock                   (<link linkend="lu-context-t">lu_context_t</link> *context,
878
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
879
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
877
<indexterm><primary>lu_group_lock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_lock                       (<link linkend="lu-context-t">lu_context_t</link> *context,
 
878
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
879
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
880
880
<para>
881
881
Locks a group account
882
882
</para><variablelist role="params">
897
897
</variablelist></refsect2>
898
898
<refsect2>
899
899
<title><anchor id="lu-group-unlock" role="function"/>lu_group_unlock ()</title>
900
 
<indexterm><primary>lu_group_unlock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_unlock                 (<link linkend="lu-context-t">lu_context_t</link> *context,
901
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
902
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
900
<indexterm><primary>lu_group_unlock</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_unlock                     (<link linkend="lu-context-t">lu_context_t</link> *context,
 
901
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
902
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
903
903
<para>
904
904
Unlocks a group account.
905
905
</para><variablelist role="params">
920
920
</variablelist></refsect2>
921
921
<refsect2>
922
922
<title><anchor id="lu-group-unlock-nonempty" role="function"/>lu_group_unlock_nonempty ()</title>
923
 
<indexterm><primary>lu_group_unlock_nonempty</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_unlock_nonempty        (<link linkend="lu-context-t">lu_context_t</link> *context,
924
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
925
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
923
<indexterm><primary>lu_group_unlock_nonempty</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_unlock_nonempty            (<link linkend="lu-context-t">lu_context_t</link> *context,
 
924
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
925
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
926
926
<para>
927
927
Unlocks a group account.  If unlocking the account would result in an empty
928
928
password field, it fails with <link linkend="lu-error-unlock-empty"><literal>lu_error_unlock_empty</literal></link>.  Note that the
945
945
</variablelist></refsect2>
946
946
<refsect2>
947
947
<title><anchor id="lu-group-islocked" role="function"/>lu_group_islocked ()</title>
948
 
<indexterm><primary>lu_group_islocked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_group_islocked               (<link linkend="lu-context-t">lu_context_t</link> *context,
949
 
                                             struct <link linkend="lu-ent">lu_ent</link> *ent,
950
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
948
<indexterm><primary>lu_group_islocked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lu_group_islocked                   (<link linkend="lu-context-t">lu_context_t</link> *context,
 
949
                                                         <link linkend="struct-lu-ent">struct lu_ent</link> *ent,
 
950
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
951
951
<para>
952
952
Checks if a group account is locked.
953
953
</para><variablelist role="params">
967
967
</variablelist></refsect2>
968
968
<refsect2>
969
969
<title><anchor id="lu-groups-enumerate" role="function"/>lu_groups_enumerate ()</title>
970
 
<indexterm><primary>lu_groups_enumerate</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>* lu_groups_enumerate            (<link linkend="lu-context-t">lu_context_t</link> *context,
971
 
                                             const <link linkend="char">char</link> *pattern,
972
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
970
<indexterm><primary>lu_groups_enumerate</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>*        lu_groups_enumerate                 (<link linkend="lu-context-t">lu_context_t</link> *context,
 
971
                                                         const <link linkend="char">char</link> *pattern,
 
972
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
973
973
<para>
974
974
Returns a list of all groups matching a pattern.
975
975
</para><variablelist role="params">
990
990
</variablelist></refsect2>
991
991
<refsect2>
992
992
<title><anchor id="lu-groups-enumerate-by-user" role="function"/>lu_groups_enumerate_by_user ()</title>
993
 
<indexterm><primary>lu_groups_enumerate_by_user</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>* lu_groups_enumerate_by_user    (<link linkend="lu-context-t">lu_context_t</link> *context,
994
 
                                             const <link linkend="char">char</link> *user,
995
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
993
<indexterm><primary>lu_groups_enumerate_by_user</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>*        lu_groups_enumerate_by_user         (<link linkend="lu-context-t">lu_context_t</link> *context,
 
994
                                                         const <link linkend="char">char</link> *user,
 
995
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
996
996
<para>
997
997
Returns a list of all groups containing an user <parameter>user</parameter>.
998
998
</para><variablelist role="params">
1013
1013
</variablelist></refsect2>
1014
1014
<refsect2>
1015
1015
<title><anchor id="lu-groups-enumerate-full" role="function"/>lu_groups_enumerate_full ()</title>
1016
 
<indexterm><primary>lu_groups_enumerate_full</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*  lu_groups_enumerate_full        (<link linkend="lu-context-t">lu_context_t</link> *context,
1017
 
                                             const <link linkend="char">char</link> *pattern,
1018
 
                                             <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
 
1016
<indexterm><primary>lu_groups_enumerate_full</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*          lu_groups_enumerate_full            (<link linkend="lu-context-t">lu_context_t</link> *context,
 
1017
                                                         const <link linkend="char">char</link> *pattern,
 
1018
                                                         <link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
1019
1019
<para>
1020
1020
Returns a list of entities, one for each group matching a pattern.
1021
1021
</para><variablelist role="params">
1040
1040
 
1041
1041
 
1042
1042
 
 
1043
 
 
1044
<refsect1><refsect2 /><refsect2 /></refsect1>
1043
1045
</refentry>