Browse Source

Update README.md

theo 2 years ago
parent
commit
cf675abf86
1 changed files with 19 additions and 8 deletions
  1. 19 8
      README.md

+ 19 - 8
README.md

@@ -11,15 +11,25 @@ Then, edit `.env` and set the correct values
 
 - createperson
 
-This script doesn't take any arguments. Instead, it will ask you to enter the necessary info.
-It also asks you if the user should be a posixAccount and for any groups you want to add them to.
+Create an account, with the following parameters :
+
+```
+-u <uid> : the new user's uid
+-n <first name> : the new user's first name
+-s <last name> : the new user's uid
+-p (optional) : give the user the `posixAccount` object class, and the necessary attributes. 
+This is necessary if the user needs to be added to posix Groups
+-g <group1[,group2,group3,...]> : add the user the to one or more groups 
+(separated by commas when more than one group is given)
+```
 
 - removeperson
 
 Removes a user from the directory, including the corresponding posixGroup
 if the user is a posixAccount.
+The -y option can be given as the first argument to bypass the confirmation prompt
 ```
-./removeperson uid
+./removeperson [-y] uid
 ```
 
 
@@ -28,8 +38,8 @@ if the user is a posixAccount.
 Since adding the first user needs to be done at the creation of the group,
 a valid uid needs to be passed to the script.
 
-The optional -p flag must be passed as the first argument. It indicates
-that the group to be created is a posixGroup. Therefore, the first user also need to
+The optional -p option can be given as the first argument. It indicates
+that the group to be created is a posixGroup. Therefore, the user also needs to
 be a posixAccount.
 
 ```
@@ -38,9 +48,9 @@ be a posixAccount.
 
 - addtogroups and removefromgroups
 
-Adds a user to one or more groups. User's uid must be the first argument.
+Add or remove an user to/from one or more groups. User's uid must be the first argument.
 Posix and non-posix groups can be given, but if posixGroups are given, the
-user need to be a posixAccount.
+user needs to be a posixAccount.
 
 ```
 ./addtogroups uid group1 [group2, group3,  ...]
@@ -49,7 +59,8 @@ user need to be a posixAccount.
 
 - person2posix
 
-Converts an inetOrgPerson account to a posixAccount.
+Give the user the `posixAccount` object class, and the necessary attributes,
+and create a posixGroup with the same the uid and number as the user.
 
 ```
 ./person2posix uid