From a2a1883e04aaa923b385cbbc496395ed5bf1dc17 Mon Sep 17 00:00:00 2001 From: tmanevik Date: Mon, 6 Jul 2015 21:21:27 +0200 Subject: Inets Reference Manual Editorial changes --- lib/inets/doc/src/mod_auth.xml | 260 ++++++++++++++++++++--------------------- 1 file changed, 130 insertions(+), 130 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 fda945cf73..8bef025be8 100644 --- a/lib/inets/doc/src/mod_auth.xml +++ b/lib/inets/doc/src/mod_auth.xml @@ -30,68 +30,68 @@ mod_auth.sgml mod_auth - User authentication using text files, dets or mnesia database. + 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, or Mnesia databases.

 - add_user(UserName, Options) -> true| {error, Reason} + add_user(UserName, Options) -> true| {error, Reason} add_user(UserName, Password, UserData, Port, Dir) -> true | {error, Reason} add_user(UserName, Password, UserData, Address, Port, Dir) -> true | {error, Reason} - Add a user to the user database. + Adds a user to the user database. - UserName = string() - Options = [Option] - Option = {password,Password} | {userData,UserData} | {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Password = string() - UserData = term() - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() + UserName = string() + Options = [Option] + Option = {password,Password} | {userData,UserData} | {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Password = string() + UserData = term() + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() AuthPassword =string() - Reason = term() + Reason = term() -

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 each 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, options Password, + UserData, Port, and Dir are mandatory.

 - delete_user(UserName,Options) -> true | {error, Reason} + delete_user(UserName,Options) -> true | {error, Reason} delete_user(UserName, Port, Dir) -> true | {error, Reason} delete_user(UserName, Address, Port, Dir) -> true | {error, Reason} - Delete a user from the user database. + Deletes a user from the user database. - UserName = string() - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() + UserName = string() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() AuthPassword = string() - Reason = term() + Reason = term() -

delete_user/2, delete_user/3 and delete_user/4 - deletes a user from the user database. +

delete_user/2, delete_user/3, and delete_user/4 + each 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 + When delete_user/2 is called, options Port and Dir are mandatory.

@@ -104,22 +104,22 @@ get_user(UserName, Address, Port, Dir) -> {ok, #httpd_user} | {error, Reason} Returns a user from the user database. - UserName = string() - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() + UserName = string() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() AuthPassword = string() - Reason = term() + Reason = term() -

get_user/2, get_user/3 and get_user/4 returns a - httpd_user record containing the userdata for a +

get_user/2, get_user/3, and get_user/4 each + returns an 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.

+ is returned. When get_user/2 is called, options Port and Dir + are mandatory.

 @@ -129,24 +129,24 @@ list_users(Options) -> {ok, Users} | {error, Reason} list_users(Port, Dir) -> {ok, Users} | {error, Reason} list_users(Address, Port, Dir) -> {ok, Users} | {error, Reason} - List users in the user database. + Lists users in the user database. - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() - Users = list() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() + Users = list() AuthPassword = string() - Reason = atom() + Reason = atom() -

list_users/1, list_users/2 and list_users/3 - returns a list +

list_users/1, list_users/2, and list_users/3 + each 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.

+ When list_users/1 is called, options Port and Dir + are mandatory.

 @@ -156,27 +156,27 @@ add_group_member(GroupName, UserName, Options) -> true | {error, Reason} add_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} add_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} - Add a user to a group. + Adds a user to a group. - GroupName = string() - UserName = string() - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() + GroupName = string() + UserName = string() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() AuthPassword = string() - Reason = term() + Reason = term() -

add_group_member/3, add_group_member/4 and - add_group_member/5 +

add_group_member/3, add_group_member/4, and + add_group_member/5 each 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.

+ is called, options Port and Dir are mandatory.

 @@ -186,26 +186,26 @@ delete_group_member(GroupName, UserName, Options) -> true | {error, Reason} delete_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} delete_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} - Remove a user from a group. + Removes a user from a group. - GroupName = string() - UserName = string() - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() + GroupName = string() + UserName = string() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() AuthPassword = string() - Reason = term() + Reason = term() -

delete_group_member/3, delete_group_member/4 and - delete_group_member/5 deletes a user from a group. +

delete_group_member/3, delete_group_member/4, and + delete_group_member/5 each 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.

+ this function returns an error, otherwise true. + When delete_group_member/3 is called, the options Port + and Dir are mandatory.

 @@ -215,26 +215,26 @@ list_group_members(GroupName, Options) -> {ok, Users} | {error, Reason} list_group_members(GroupName, Port, Dir) -> {ok, Users} | {error, Reason} list_group_members(GroupName, Address, Port, Dir) -> {ok, Users} | {error, Reason} - List the members of a group. + Lists the members of a group. - GroupName = string() - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() - Users = list() + GroupName = string() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() + Users = list() AuthPassword = string() - Reason = term() + Reason = term() -

list_group_members/2, list_group_members/3 and - list_group_members/4 +

list_group_members/2, list_group_members/3, and + list_group_members/4 each 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.

+ When list_group_members/2 is called, options Port + and Dir are mandatory.

 @@ -244,24 +244,24 @@ list_groups(Options) -> {ok, Groups} | {error, Reason} list_groups(Port, Dir) -> {ok, Groups} | {error, Reason} list_groups(Address, Port, Dir) -> {ok, Groups} | {error, Reason} - List all the groups. + Lists all the groups. - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() - Groups = list() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() + Groups = list() AuthPassword = string() - Reason = term() + Reason = term() -

list_groups/1, list_groups/2 and list_groups/3 - lists all the groups available. +

list_groups/1, list_groups/2, and list_groups/3 + each 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.

+ When list_groups/1 is called, options Port + and Dir are mandatory.

 @@ -270,24 +270,24 @@ 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} - Deletes a group + Deletes a group. - Options = [Option] - Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() - GroupName = string() + Options = [Option] + Option = {port,Port} | {addr,Address} | {dir,Directory} | {authPassword,AuthPassword} + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() + GroupName = string() AuthPassword = string() - Reason = term() + Reason = term() -

delete_group/2, delete_group/3 and delete_group/4 - deletes the group specified and returns true. +

delete_group/2, delete_group/3, and delete_group/4 + each 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.

+ When delete_group/2 is called, option + Port and Dir are mandatory.

 @@ -296,23 +296,23 @@ update_password(Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} update_password(Address,Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} - Change the AuthAcessPassword + Changes AuthAcessPassword. - Port = integer() - Address = {A,B,C,D} | string() | undefined - Dir = string() - GroupName = string() - OldPassword = string() - NewPassword = string() - Reason = term() + Port = integer() + Address = {A,B,C,D} | string() | undefined + Dir = string() + GroupName = string() + OldPassword = string() + NewPassword = string() + Reason = term() -

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 +

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

 @@ -322,7 +322,7 @@ SEE ALSO

httpd(3), - mod_alias(3),

+ mod_alias(3)

-- cgit v1.2.3