diff options
Diffstat (limited to 'reference/tmpl')
| -rw-r--r-- | reference/tmpl/.cvsignore | 1 | ||||
| -rw-r--r-- | reference/tmpl/empty.sgml | 0 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-acl.sgml | 164 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-attributes.sgml | 96 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-daemon.sgml | 36 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-find.sgml | 95 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-generic-callbacks.sgml | 58 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-item-info.sgml | 133 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-items.sgml | 318 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-keyring-info.sgml | 104 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-keyrings.sgml | 291 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-memory.sgml | 100 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-misc.sgml | 43 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-network.sgml | 122 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-password.sgml | 173 | ||||
| -rw-r--r-- | reference/tmpl/gnome-keyring-result.sgml | 45 |
16 files changed, 0 insertions, 1779 deletions
diff --git a/reference/tmpl/.cvsignore b/reference/tmpl/.cvsignore deleted file mode 100644 index 078ee879..00000000 --- a/reference/tmpl/.cvsignore +++ /dev/null @@ -1 +0,0 @@ -*.sgml diff --git a/reference/tmpl/empty.sgml b/reference/tmpl/empty.sgml deleted file mode 100644 index e69de29b..00000000 --- a/reference/tmpl/empty.sgml +++ /dev/null diff --git a/reference/tmpl/gnome-keyring-acl.sgml b/reference/tmpl/gnome-keyring-acl.sgml deleted file mode 100644 index aaafb890..00000000 --- a/reference/tmpl/gnome-keyring-acl.sgml +++ /dev/null @@ -1,164 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-acl - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item ACLs - -<!-- ##### SECTION Long_Description ##### --> -<para>Each item has an access control list, which specifies the applications that -can read, write or delete an item. The read access applies only to reading the secret. -All applications can read other parts of the item. ACLs are accessed and changed -gnome_keyring_item_get_acl() and gnome_keyring_item_set_acl().</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### TYPEDEF GnomeKeyringAccessControl ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF GnomeKeyringApplicationRef ##### --> -<para> - -</para> - - -<!-- ##### ENUM GnomeKeyringAccessType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ACCESS_READ: -@GNOME_KEYRING_ACCESS_WRITE: -@GNOME_KEYRING_ACCESS_REMOVE: - -<!-- ##### FUNCTION gnome_keyring_application_ref_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_application_ref_copy ##### --> -<para> - -</para> - -@app: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_application_ref_free ##### --> -<para> - -</para> - -@app: - - -<!-- ##### FUNCTION gnome_keyring_access_control_new ##### --> -<para> - -</para> - -@application: -@types_allowed: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_access_control_copy ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_access_control_free ##### --> -<para> - -</para> - -@ac: - - -<!-- ##### FUNCTION gnome_keyring_acl_copy ##### --> -<para> - -</para> - -@list: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_acl_free ##### --> -<para> - -</para> - -@acl: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_display_name ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_display_name ##### --> -<para> - -</para> - -@ac: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_path_name ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_path_name ##### --> -<para> - -</para> - -@ac: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_get_access_type ##### --> -<para> - -</para> - -@ac: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_ac_set_access_type ##### --> -<para> - -</para> - -@ac: -@value: - - diff --git a/reference/tmpl/gnome-keyring-attributes.sgml b/reference/tmpl/gnome-keyring-attributes.sgml deleted file mode 100644 index daff4631..00000000 --- a/reference/tmpl/gnome-keyring-attributes.sgml +++ /dev/null @@ -1,96 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-attributes - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item Attributes - -<!-- ##### SECTION Long_Description ##### --> -<para>Attributes allow various other pieces of information to be associated with an item. -These can also be used to search for relevant items. Use gnome_keyring_item_get_attributes() -or gnome_keyring_item_set_attributes().</para> - -<para>Each attribute has either a string, or unsigned integer value.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringAttributeType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ATTRIBUTE_TYPE_STRING: -@GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32: - -<!-- ##### TYPEDEF GnomeKeyringAttributeList ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GnomeKeyringAttribute ##### --> -<para> - -</para> - -@name: -@type: - -<!-- ##### MACRO gnome_keyring_attribute_list_index ##### --> -<para> - -</para> - -@a: -@i: - - -<!-- ##### MACRO gnome_keyring_attribute_list_new ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_append_string ##### --> -<para> - -</para> - -@attributes: -@name: -@value: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_append_uint32 ##### --> -<para> - -</para> - -@attributes: -@name: -@value: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_free ##### --> -<para> - -</para> - -@attributes: - - -<!-- ##### FUNCTION gnome_keyring_attribute_list_copy ##### --> -<para> - -</para> - -@attributes: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-daemon.sgml b/reference/tmpl/gnome-keyring-daemon.sgml deleted file mode 100644 index 217b1d3f..00000000 --- a/reference/tmpl/gnome-keyring-daemon.sgml +++ /dev/null @@ -1,36 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Daemon Management Functions - -<!-- ##### SECTION Short_Description ##### --> -Functions used by session managers to manage the Gnome Keyring Daemon. - -<!-- ##### SECTION Long_Description ##### --> -<para> -These functions are not used by most applications using Gnome Keyring. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_daemon_set_display_sync ##### --> -<para> - -</para> - -@display: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_daemon_prepare_environment_sync ##### --> -<para> - -</para> - -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-find.sgml b/reference/tmpl/gnome-keyring-find.sgml deleted file mode 100644 index 86d2ef22..00000000 --- a/reference/tmpl/gnome-keyring-find.sgml +++ /dev/null @@ -1,95 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-find - -<!-- ##### SECTION Short_Description ##### --> -Find Keyring Items - -<!-- ##### SECTION Long_Description ##### --> -<para>A find operation searches through all keyrings for items that match the -attributes. The user may have been prompted to unlock necessary keyrings, and -user will have been prompted for access to the items if needed.</para> - -<para>A find operation may return multiple or zero results.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringFound ##### --> -<para> - -</para> - -@keyring: -@item_id: -@attributes: -@secret: - -<!-- ##### FUNCTION gnome_keyring_found_free ##### --> -<para> - -</para> - -@found: - - -<!-- ##### FUNCTION gnome_keyring_found_list_free ##### --> -<para> - -</para> - -@found_list: - - -<!-- ##### FUNCTION gnome_keyring_find_items ##### --> -<para> - -</para> - -@type: -@attributes: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_itemsv ##### --> -<para> - -</para> - -@type: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_items_sync ##### --> -<para> - -</para> - -@type: -@attributes: -@found: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_itemsv_sync ##### --> -<para> - -</para> - -@type: -@found: -@Varargs: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-generic-callbacks.sgml b/reference/tmpl/gnome-keyring-generic-callbacks.sgml deleted file mode 100644 index 0357915c..00000000 --- a/reference/tmpl/gnome-keyring-generic-callbacks.sgml +++ /dev/null @@ -1,58 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-generic-callbacks - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationDoneCallback ##### --> -<para> - -</para> - -@result: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetIntCallback ##### --> -<para> - -</para> - -@result: -@val: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetListCallback ##### --> -<para> - -</para> - -@result: -@list: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetStringCallback ##### --> -<para> - -</para> - -@result: -@string: -@data: - - diff --git a/reference/tmpl/gnome-keyring-item-info.sgml b/reference/tmpl/gnome-keyring-item-info.sgml deleted file mode 100644 index 9a659557..00000000 --- a/reference/tmpl/gnome-keyring-item-info.sgml +++ /dev/null @@ -1,133 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-item-info - -<!-- ##### SECTION Short_Description ##### --> -Keyring Item Info - -<!-- ##### SECTION Long_Description ##### --> -<para>#GnomeKeyringItemInfo represents the basic information about a keyring item. -Use gnome_keyring_item_get_info() or gnome_keyring_item_set_info().</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringItemType ##### --> -<para> - -</para> - -@GNOME_KEYRING_ITEM_GENERIC_SECRET: -@GNOME_KEYRING_ITEM_NETWORK_PASSWORD: -@GNOME_KEYRING_ITEM_NOTE: -@GNOME_KEYRING_ITEM_CHAINED_KEYRING_PASSWORD: -@GNOME_KEYRING_ITEM_ENCRYPTION_KEY_PASSWORD: -@GNOME_KEYRING_ITEM_LAST_TYPE: - -<!-- ##### TYPEDEF GnomeKeyringItemInfo ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gnome_keyring_item_info_free ##### --> -<para> - -</para> - -@item_info: - - -<!-- ##### FUNCTION gnome_keyring_item_info_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_copy ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_type ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_type ##### --> -<para> - -</para> - -@item_info: -@type: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_secret ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_secret ##### --> -<para> - -</para> - -@item_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_display_name ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_set_display_name ##### --> -<para> - -</para> - -@item_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_mtime ##### --> -<para> - -</para> - -@item_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_info_get_ctime ##### --> -<para> - -</para> - -@item_info: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-items.sgml b/reference/tmpl/gnome-keyring-items.sgml deleted file mode 100644 index ae862300..00000000 --- a/reference/tmpl/gnome-keyring-items.sgml +++ /dev/null @@ -1,318 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-items - -<!-- ##### SECTION Short_Description ##### --> -Keyring Items - -<!-- ##### SECTION Long_Description ##### --> -<para>A keyring contains multiple items. Each item has a secret, attributes and access -information associated with it. </para> - -<para>An item is identified by an unsigned integer unique to the keyring in which it -exists. An item's name is for displaying to the user. Each item has a single secret, -which is a null-terminated string. This secret is stored in non-pageable memory, and -encrypted on disk. All of this information is exposed via #GnomeKeyringItemInfo -pointers</para> - -<para>Attributes allow various other pieces of information to be associated with an item. -These can also be used to search for relevant items. Attributes are accessed with -#GnomeKeyringAttribute structures and built into lists using #GnomeKeyringAttributeList.</para> - -<para>Each item has an access control list, which specifies the applications that -can read, write or delete an item. The read access applies only to reading the secret. -All applications can read other parts of the item. ACLs are accessed and changed -through #GnomeKeyringAccessControl pointers.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GnomeKeyringItemInfoFlags ##### --> -<para> - -</para> - -@GNOME_KEYRING_ITEM_INFO_BASICS: -@GNOME_KEYRING_ITEM_INFO_SECRET: - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetItemInfoCallback ##### --> -<para> - -</para> - -@result: -@info: -@data: - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetAttributesCallback ##### --> -<para> - -</para> - -@result: -@attributes: -@data: - - -<!-- ##### FUNCTION gnome_keyring_item_create ##### --> -<para> - -</para> - -@keyring: -@type: -@display_name: -@attributes: -@secret: -@update_if_exists: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_create_sync ##### --> -<para> - -</para> - -@keyring: -@type: -@display_name: -@attributes: -@secret: -@update_if_exists: -@item_id: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_delete ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_delete_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_full ##### --> -<para> - -</para> - -@keyring: -@id: -@flags: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_full_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@flags: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_info_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_info ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_info_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_attributes ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_attributes_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_attributes ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_attributes_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@attributes: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_acl ##### --> -<para> - -</para> - -@keyring: -@id: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_get_acl_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_acl ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_set_acl_sync ##### --> -<para> - -</para> - -@keyring: -@id: -@acl: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_grant_access_rights ##### --> -<para> - -</para> - -@keyring: -@display_name: -@full_path: -@id: -@rights: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_item_grant_access_rights_sync ##### --> -<para> - -</para> - -@keyring: -@display_name: -@full_path: -@id: -@rights: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-keyring-info.sgml b/reference/tmpl/gnome-keyring-keyring-info.sgml deleted file mode 100644 index 6280bf70..00000000 --- a/reference/tmpl/gnome-keyring-keyring-info.sgml +++ /dev/null @@ -1,104 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-keyring-info - -<!-- ##### SECTION Short_Description ##### --> -Keyring Information - -<!-- ##### SECTION Long_Description ##### --> -<para>Use gnome_keyring_get_info() or gnome_keyring_get_info_sync() to get a #GnomeKeyringInfo -pointer to use with these functions.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### TYPEDEF GnomeKeyringInfo ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gnome_keyring_info_free ##### --> -<para> - -</para> - -@keyring_info: - - -<!-- ##### FUNCTION gnome_keyring_info_copy ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_set_lock_on_idle ##### --> -<para> - -</para> - -@keyring_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_info_get_lock_on_idle ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_set_lock_timeout ##### --> -<para> - -</para> - -@keyring_info: -@value: - - -<!-- ##### FUNCTION gnome_keyring_info_get_lock_timeout ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_mtime ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_ctime ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_info_get_is_locked ##### --> -<para> - -</para> - -@keyring_info: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-keyrings.sgml b/reference/tmpl/gnome-keyring-keyrings.sgml deleted file mode 100644 index 3b7e500d..00000000 --- a/reference/tmpl/gnome-keyring-keyrings.sgml +++ /dev/null @@ -1,291 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-keyrings - -<!-- ##### SECTION Short_Description ##### --> -Keyrings - -<!-- ##### SECTION Long_Description ##### --> -<para>%gnome-keyring-daemon manages multiple keyrings. Each keyring can store one or more items containing secrets.</para> - -<para>One of the keyrings is the default keyring, which can in many cases be used by specifying %NULL for a keyring name.</para> - -<para>Each keyring can be in a locked or unlocked state. A password must be specified, either by the user or the calling application, to unlock the keyring.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### USER_FUNCTION GnomeKeyringOperationGetKeyringInfoCallback ##### --> -<para> - -</para> - -@result: -@info: -@data: - - -<!-- ##### FUNCTION gnome_keyring_set_default_keyring ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_default_keyring_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_default_keyring ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_default_keyring_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_keyring_names ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_keyring_names_sync ##### --> -<para> - -</para> - -@keyrings: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_all ##### --> -<para> - -</para> - -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_all_sync ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_create ##### --> -<para> - -</para> - -@keyring_name: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_create_sync ##### --> -<para> - -</para> - -@keyring_name: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_unlock ##### --> -<para> - -</para> - -@keyring: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_unlock_sync ##### --> -<para> - -</para> - -@keyring: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_lock_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_sync ##### --> -<para> - -</para> - -@keyring: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_info ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_get_info_sync ##### --> -<para> - -</para> - -@keyring: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_info ##### --> -<para> - -</para> - -@keyring: -@info: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_info_sync ##### --> -<para> - -</para> - -@keyring: -@info: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_change_password ##### --> -<para> - -</para> - -@keyring: -@original: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_change_password_sync ##### --> -<para> - -</para> - -@keyring: -@original: -@password: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_item_ids ##### --> -<para> - -</para> - -@keyring: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_list_item_ids_sync ##### --> -<para> - -</para> - -@keyring: -@ids: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-memory.sgml b/reference/tmpl/gnome-keyring-memory.sgml deleted file mode 100644 index e454b3e3..00000000 --- a/reference/tmpl/gnome-keyring-memory.sgml +++ /dev/null @@ -1,100 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-memory - -<!-- ##### SECTION Short_Description ##### --> -Secure Non-pageable Memory - -<!-- ##### SECTION Long_Description ##### --> -<para> -Normal allocated memory can be paged to disk at the whim of the operating system. -This is a serious problems for sensitive information like passwords, keys and secrets. -</para> - -<para>GNOME Keyring holds passwords in non-pageable, or locked memory. This happens -both in the daemon and in the library. This is only possible if the OS contains -support for it.</para> - -<para>These functions allow applications to use to hold passwords and other -sensitive information.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO gnome_keyring_memory_new ##### --> -<para> - -</para> - -@type: -@n_objects: - - -<!-- ##### FUNCTION gnome_keyring_memory_alloc ##### --> -<para> - -</para> - -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_try_alloc ##### --> -<para> - -</para> - -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_realloc ##### --> -<para> - -</para> - -@p: -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_try_realloc ##### --> -<para> - -</para> - -@p: -@sz: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_free ##### --> -<para> - -</para> - -@p: - - -<!-- ##### FUNCTION gnome_keyring_memory_is_secure ##### --> -<para> - -</para> - -@p: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_memory_strdup ##### --> -<para> - -</para> - -@str: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-misc.sgml b/reference/tmpl/gnome-keyring-misc.sgml deleted file mode 100644 index 411efd16..00000000 --- a/reference/tmpl/gnome-keyring-misc.sgml +++ /dev/null @@ -1,43 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-misc - -<!-- ##### SECTION Short_Description ##### --> -Miscellaneous Functions - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_is_available ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_cancel_request ##### --> -<para> - -</para> - -@request: - - -<!-- ##### FUNCTION gnome_keyring_string_list_free ##### --> -<para> - -</para> - -@strings: - - diff --git a/reference/tmpl/gnome-keyring-network.sgml b/reference/tmpl/gnome-keyring-network.sgml deleted file mode 100644 index dee77e54..00000000 --- a/reference/tmpl/gnome-keyring-network.sgml +++ /dev/null @@ -1,122 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-network - -<!-- ##### SECTION Short_Description ##### --> -Network Passwords - -<!-- ##### SECTION Long_Description ##### --> -<para>Networks passwords are a simple way of saving passwords associated with a -certain user/server/protocol and other fields.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringNetworkPasswordData ##### --> -<para> - -</para> - -@keyring: -@item_id: -@protocol: -@server: -@object: -@authtype: -@port: -@user: -@domain: -@password: - -<!-- ##### FUNCTION gnome_keyring_network_password_free ##### --> -<para> - -</para> - -@data: - - -<!-- ##### FUNCTION gnome_keyring_network_password_list_free ##### --> -<para> - -</para> - -@list: - - -<!-- ##### FUNCTION gnome_keyring_find_network_password ##### --> -<para> - -</para> - -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_network_password_sync ##### --> -<para> - -</para> - -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@results: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_network_password ##### --> -<para> - -</para> - -@keyring: -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@password: -@callback: -@data: -@destroy_data: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_set_network_password_sync ##### --> -<para> - -</para> - -@keyring: -@user: -@domain: -@server: -@object: -@protocol: -@authtype: -@port: -@password: -@item_id: -@Returns: - - diff --git a/reference/tmpl/gnome-keyring-password.sgml b/reference/tmpl/gnome-keyring-password.sgml deleted file mode 100644 index cba8b008..00000000 --- a/reference/tmpl/gnome-keyring-password.sgml +++ /dev/null @@ -1,173 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Simple Password Storage - -<!-- ##### SECTION Short_Description ##### --> -Store and lookup passwords with a set of attributes. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This is a simple API for storing passwords and retrieving passwords in the keyring. -</para> -<para> -Each password is associated with a set of attributes. Attribute values can be either -strings or unsigned integers. -The names and types of allowed attributes for a given password are defined with a -schema. Certain schemas are predefined such as %GNOME_KEYRING_NETWORK_PASSWORD. -Additional schemas can be defined via the %GnomeKeyringPasswordSchema structure. -</para> -<para> -Each function accepts a variable list of attributes names and their values. -Include a %NULL to terminate the list of attributes. -</para> -<example> -<title>Passing attributes to the functions</title> -<programlisting> - res = gnome_keyring_delete_password_sync (GNOME_KEYRING_NETWORK_PASSWORD, - "user", "me", /* A string attribute */ - "server, "example.gnome.org", - "port", "8080", /* An integer attribute */ - NULL); -</programlisting></example> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT GnomeKeyringPasswordSchema ##### --> -<para> -Describes a password schema. Often you'll want to use a predefined schema such -as %GNOME_KEYRING_NETWORK_PASSWORD. -</para> - -<para> -The last attribute name in a schema must be %NULL. - -<programlisting> - GnomeKeyringPasswordSchema my_schema = { - GNOME_KEYRING_ITEM_GENERIC_SECRET, - { - { "string-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_STRING }, - { "uint-attr", GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32 }, - { NULL, 0 } - } - }; -</programlisting> -</para> - -@item_type: - -<!-- ##### VARIABLE GNOME_KEYRING_NETWORK_PASSWORD ##### --> -<para> -A predefined schema for network paswsords. It contains the following attributes: -</para> -<itemizedlist> -<listitem>user: A string for the user login.</listitem> -<listitem>server: The server being connected to.</listitem> -<listitem>protocol: The protocol used to access the server, such as 'http' or 'smb'</listitem> -<listitem>domain: A realm or domain, such as a Windows login domain.</listitem> -<listitem>port: The network port to used to connect to the server.</listitem> -</itemizedlist> - - -<!-- ##### MACRO GNOME_KEYRING_DEFAULT ##### --> -<para> -The default keyring. -</para> - - - -<!-- ##### MACRO GNOME_KEYRING_SESSION ##### --> -<para> -A keyring only stored in memory. -</para> - - - -<!-- ##### FUNCTION gnome_keyring_store_password ##### --> -<para> - -</para> - -@schema: -@keyring: -@display_name: -@password: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_store_password_sync ##### --> -<para> - -</para> - -@schema: -@keyring: -@display_name: -@password: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_password ##### --> -<para> - -</para> - -@schema: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_find_password_sync ##### --> -<para> - -</para> - -@schema: -@password: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_password ##### --> -<para> - -</para> - -@schema: -@callback: -@data: -@destroy_data: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_delete_password_sync ##### --> -<para> - -</para> - -@schema: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gnome_keyring_free_password ##### --> -<para> - -</para> - -@password: - - diff --git a/reference/tmpl/gnome-keyring-result.sgml b/reference/tmpl/gnome-keyring-result.sgml deleted file mode 100644 index 3ead2a66..00000000 --- a/reference/tmpl/gnome-keyring-result.sgml +++ /dev/null @@ -1,45 +0,0 @@ -<!-- ##### SECTION Title ##### --> -gnome-keyring-result - -<!-- ##### SECTION Short_Description ##### --> -Result Codes - -<!-- ##### SECTION Long_Description ##### --> -<para> -Result codes used through out GNOME Keyring. Additional result codes may be -added from time to time and these should be handled gracefully. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION gnome_keyring_result_to_message ##### --> -<para> - -</para> - -@res: -@Returns: - - -<!-- ##### ENUM GnomeKeyringResult ##### --> -<para> - -</para> - -@GNOME_KEYRING_RESULT_OK: -@GNOME_KEYRING_RESULT_DENIED: -@GNOME_KEYRING_RESULT_NO_KEYRING_DAEMON: -@GNOME_KEYRING_RESULT_ALREADY_UNLOCKED: -@GNOME_KEYRING_RESULT_NO_SUCH_KEYRING: -@GNOME_KEYRING_RESULT_BAD_ARGUMENTS: -@GNOME_KEYRING_RESULT_IO_ERROR: -@GNOME_KEYRING_RESULT_CANCELLED: -@GNOME_KEYRING_RESULT_KEYRING_ALREADY_EXISTS: -@GNOME_KEYRING_RESULT_NO_MATCH: - |