From dbf9c223cf7efd8fc6143b573fcc12637d5ae9ae Mon Sep 17 00:00:00 2001 From: Micael Karlberg Date: Thu, 15 Mar 2012 12:00:58 +0100 Subject: [inets] Some documentation cleanup OTP-9983 --- lib/inets/doc/src/mod_auth.xml | 133 +++++++++++++++++++++++++++-------------- 1 file changed, 87 insertions(+), 46 deletions(-) (limited to 'lib/inets/doc/src/mod_auth.xml') diff --git a/lib/inets/doc/src/mod_auth.xml b/lib/inets/doc/src/mod_auth.xml index 2134ebeeae..7801567862 100644 --- a/lib/inets/doc/src/mod_auth.xml +++ b/lib/inets/doc/src/mod_auth.xml @@ -1,4 +1,4 @@ - + @@ -32,8 +32,11 @@ User authentication using text files, dets or mnesia database.

This module provides for basic user authentication using - textual files, dets databases as well as mnesia databases.

+ textual files, dets databases as well as mnesia databases.

+ + + add_user(UserName, Options) -> true| {error, Reason} @@ -55,12 +58,17 @@ -

add_user/2, add_user/5 and add_user/6 adds a user to the user - database. If the operation is successful, this function returns - true. If an error occurs, {error,Reason} is returned. When add_user/2 - is called the Password, UserData Port and Dir options is mandatory.

+

add_user/2, add_user/5 and add_user/6 adds a + user to the user + database. If the operation is successful, this function returns + true. If an error occurs, {error,Reason} is returned. + When add_user/2 is called the Password, + UserData Port and Dir options is mandatory.

+ + + delete_user(UserName,Options) -> true | {error, Reason} delete_user(UserName, Port, Dir) -> true | {error, Reason} @@ -79,13 +87,16 @@

delete_user/2, delete_user/3 and delete_user/4 - deletes a user - from the user database. If the operation is successful, this - function returns true. If an error occurs, - {error,Reason} is returned. When delete_user/2 is - called the Port and Dir options are mandatory.

+ deletes a user from the user database. + If the operation is successful, this function returns true. + If an error occurs, {error,Reason} is returned. + When delete_user/2 is called the Port and Dir options + are mandatory.

+ + + get_user(UserName,Options) -> {ok, #httpd_user} |{error, Reason} get_user(UserName, Port, Dir) -> {ok, #httpd_user} | {error, Reason} @@ -104,12 +115,15 @@

get_user/2, get_user/3 and get_user/4 returns a - httpd_user record containing the userdata for a - specific user. If the user cannot be found, {error, Reason} - is returned. When get_user/2 is called the Port and Dir - options are mandatory.

+ httpd_user record containing the userdata for a + specific user. If the user cannot be found, {error, Reason} + is returned. When get_user/2 is called the Port and Dir + options are mandatory.

+ + + list_users(Options) -> {ok, Users} | {error, Reason} list_users(Port, Dir) -> {ok, Users} | {error, Reason} @@ -127,12 +141,16 @@ -

list_users/1, list_users/2 and list_users/3 returns a list - of users in the user database for a specific Port/Dir. - When list_users/1 is called the Port and Dir - options are mandatory.

+

list_users/1, list_users/2 and list_users/3 + returns a list + of users in the user database for a specific Port/Dir. + When list_users/1 is called the Port and Dir + options are mandatory.

+ + + add_group_member(GroupName, UserName, Options) -> true | {error, Reason} add_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} @@ -151,13 +169,18 @@ -

add_group_member/3, add_group_member/4 and add_group_member/5 - adds a user to a group. If the group does not exist, it - is created and the user is added to the group. Upon successful - operation, this function returns true. When add_group_members/3 - is called the Port and Dir options are mandatory.

+

add_group_member/3, add_group_member/4 and + add_group_member/5 + adds a user to a group. If the group does not exist, it + is created and the user is added to the group. Upon successful + operation, this function returns true. + When add_group_members/3 + is called the Port and Dir options are mandatory.

+ + + delete_group_member(GroupName, UserName, Options) -> true | {error, Reason} delete_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} @@ -176,13 +199,17 @@ -

delete_group_member/3, delete_group_member/4 and delete_group_member/5 deletes a user from a group. - If the group or the user does not exist, - this function returns an error, otherwise it returns true. - When delete_group_member/3 is called the Port and Dir options - are mandatory.

+

delete_group_member/3, delete_group_member/4 and + delete_group_member/5 deletes a user from a group. + If the group or the user does not exist, + this function returns an error, otherwise it returns true. + When delete_group_member/3 is called the Port and Dir options + are mandatory.

+ + + list_group_members(GroupName, Options) -> {ok, Users} | {error, Reason} list_group_members(GroupName, Port, Dir) -> {ok, Users} | {error, Reason} @@ -201,13 +228,17 @@ -

list_group_members/2, list_group_members/3 and list_group_members/4 - lists the members of a specified group. If the group does not - exist or there is an error, {error, Reason} is returned. - When list_group_members/2 is called the Port and Dir options - are mandatory.

+

list_group_members/2, list_group_members/3 and + list_group_members/4 + lists the members of a specified group. If the group does not + exist or there is an error, {error, Reason} is returned. + When list_group_members/2 is called the Port and Dir options + are mandatory.

+ + + list_groups(Options) -> {ok, Groups} | {error, Reason} list_groups(Port, Dir) -> {ok, Groups} | {error, Reason} @@ -225,12 +256,16 @@ -

list_groups/1, list_groups/2 and list_groups/3 lists all - the groups available. If there is an error, {error, Reason} - is returned. When list_groups/1 is called the Port and Dir options - are mandatory.

+

list_groups/1, list_groups/2 and list_groups/3 + lists all the groups available. + If there is an error, {error, Reason} is returned. + When list_groups/1 is called the Port and Dir options + are mandatory.

+ + + delete_group(GroupName, Options) -> true | {error,Reason} <name>delete_group(GroupName, Port, Dir) -> true | {error, Reason} delete_group(GroupName, Address, Port, Dir) -> true | {error, Reason} @@ -247,12 +282,16 @@ -

delete_group/2, delete_group/3 and delete_group/4 deletes the - group specified and returns true. If there is an error, - {error, Reason} is returned. When delete_group/2 is called the - Port and Dir options are mandatory.

+

delete_group/2, delete_group/3 and delete_group/4 + deletes the group specified and returns true. + If there is an error, {error, Reason} is returned. + When delete_group/2 is called the + Port and Dir options are mandatory.

+ + + update_password(Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} update_password(Address,Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} @@ -268,10 +307,12 @@ -

update_password/5 and update_password/6 Updates the AuthAccessPassword - for the specified directory. If NewPassword is equal to "NoPassword" no password is requires to - change authorisation data. If NewPassword is equal to "DummyPassword" no changes can be done - without changing the password first.

+

update_password/5 and update_password/6 + Updates the AuthAccessPassword for the specified directory. + If NewPassword is equal to "NoPassword" no password is requires to + change authorisation data. + If NewPassword is equal to "DummyPassword" no changes can be done + without changing the password first.

 -- cgit v1.2.3