Browse Source

Added usage doc to README file

theo 2 years ago
parent
commit
24a326f78a
1 changed files with 43 additions and 0 deletions
  1. 43 0
      README.md

+ 43 - 0
README.md

@@ -6,3 +6,46 @@ cp .env.example .env
 ```
 
 Then, edit `.env` and set the correct values
+
+# Usage
+
+- 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.
+
+- removeperson
+
+Removes a user from the directory, including the corresponding posixGroup
+if the user is a posixAccount.
+```
+./removeperson uid
+```
+
+
+- creategroup
+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
+be a posixAccount.
+```
+./creategroup [-p] uid group
+``` 
+
+- addtogroups and removefromgroups
+Adds a user to 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.
+```
+./addtogroups uid group1 [group2, group3,  ...]
+./removefromgroups uid group1 [group2, group3,  ...]
+```
+
+- person2posix
+Converts an inetOrgPerson account to a posixAccount.
+```
+./person2posix uid
+```
+