stefan 9 months ago
parent
commit
aa57ab7bf6
1 changed files with 5 additions and 5 deletions
  1. 5 5
      doc/shellmatta_auth.dox

+ 5 - 5
doc/shellmatta_auth.dox

@@ -6,7 +6,7 @@
     It can be used to hide certain (or all) commands from users without
     permission.
 
-    Ther permissions can be set per command.
+    The permissions can be set per command.
 
     To enable the shellmatta auth module you have to include the file
     shellmatta_auth.c into your build and set the define
@@ -41,13 +41,13 @@
     Every command can get a permission matrix - the perm lists can be reused for
     multiple users with the same permissions.
     When no entry is found for a command in the permission list the command
-    default to be public.
+    defaults to be public.
 
     It is also possible to use the userID 0 to hide a command when logged in.
 
         uint32_t exampleCmdPerms[] = {2};
         shellmatta_auth_perm_t permList[] = {
-            {"adoSome2", exampleCmdPerms, sizeof(exampleCmdPerms)/sizeof(exampleCmdPerms[0])}
+            {"exampleCmd", exampleCmdPerms, sizeof(exampleCmdPerms)/sizeof(exampleCmdPerms[0])}
         };
 
     Now call the #shellmatta_auth_init method and pass the user and permissions
@@ -55,7 +55,7 @@
     It is possible to register optional callbacks for a custom password check
     and a log function which is called on every authentication event.
 
-        shellmatta_auth_init(handle, userList, 3, permList, 2, false, NULL, NULL);
+        shellmatta_auth_init(handle, userList, 3, permList, 1, false, NULL, NULL);
 
 
     @section shellmatta_auth_custom_login Custom login
@@ -63,7 +63,7 @@
     By default the shellmatta uses plain text passwords.
     This of course is not state of the art and usually highly insecure.
 
-    As most of the fancy password hashing systems are platform dependant none of
+    As most of the fancy password hashing methods are platform dependant none of
     those is included to keep up the compatibility with as many platforms as
     possible (sacrificing security).