Skip to content

Commit 34c8cf5

Browse files
committed
docs: Generate CLI docs
Via `go generate ./docs/...`
1 parent 37f17ed commit 34c8cf5

7 files changed

Lines changed: 188 additions & 0 deletions

File tree

docs/cli/authctl.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## authctl
2+
3+
CLI tool to interact with authd
4+
5+
### Synopsis
6+
7+
authctl is a command-line tool to interact with the authd service for user and group management.
8+
9+
```
10+
authctl [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for authctl
17+
```
18+
19+
### SEE ALSO
20+
21+
* [authctl group](authctl_group.md) - Commands related to groups
22+
* [authctl user](authctl_user.md) - Commands related to users
23+

docs/cli/authctl_group.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## authctl group
2+
3+
Commands related to groups
4+
5+
```
6+
authctl group [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for group
13+
```
14+
15+
### SEE ALSO
16+
17+
* [authctl](authctl.md) - CLI tool to interact with authd
18+
* [authctl group set-gid](authctl_group_set-gid.md) - Set the GID of a group managed by authd
19+

docs/cli/authctl_group_set-gid.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## authctl group set-gid
2+
3+
Set the GID of a group managed by authd
4+
5+
### Synopsis
6+
7+
Set the GID of a group managed by authd to the specified value.
8+
9+
The new GID value must be unique and non-negative.
10+
11+
When a group's GID is changed, any users whose primary group is set to this group
12+
will have their primary group GID updated. The home directories of these users and
13+
files within them owned by the group will be updated to the new GID.
14+
15+
Files outside users' home directories are not updated and must be changed
16+
manually. Note that changing a GID can be unsafe if files on the system are
17+
still owned by the original GID: those files may become accessible to a
18+
different group that is later assigned that GID. To change group ownership of
19+
all files on the system from the old GID to the new GID, run:
20+
21+
sudo chown -R --from :OLD_GID :NEW_GID /
22+
23+
This command requires root privileges.
24+
25+
```
26+
authctl group set-gid <name> <gid> [flags]
27+
```
28+
29+
### Examples
30+
31+
```
32+
# Set the GID of group "staff" to 30000
33+
authctl group set-gid staff 30000
34+
```
35+
36+
### Options
37+
38+
```
39+
-h, --help help for set-gid
40+
```
41+
42+
### SEE ALSO
43+
44+
* [authctl group](authctl_group.md) - Commands related to groups
45+

docs/cli/authctl_user.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## authctl user
2+
3+
Commands related to users
4+
5+
```
6+
authctl user [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for user
13+
```
14+
15+
### SEE ALSO
16+
17+
* [authctl](authctl.md) - CLI tool to interact with authd
18+
* [authctl user lock](authctl_user_lock.md) - Lock (disable) a user managed by authd
19+
* [authctl user set-uid](authctl_user_set-uid.md) - Set the UID of a user managed by authd
20+
* [authctl user unlock](authctl_user_unlock.md) - Unlock (enable) a user managed by authd
21+

docs/cli/authctl_user_lock.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## authctl user lock
2+
3+
Lock (disable) a user managed by authd
4+
5+
```
6+
authctl user lock <user> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for lock
13+
```
14+
15+
### SEE ALSO
16+
17+
* [authctl user](authctl_user.md) - Commands related to users
18+

docs/cli/authctl_user_set-uid.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## authctl user set-uid
2+
3+
Set the UID of a user managed by authd
4+
5+
### Synopsis
6+
7+
Set the UID of a user managed by authd to the specified value.
8+
9+
The new UID value must be unique and non-negative.
10+
11+
The user's home directory and any files within it owned by the user will
12+
automatically have their ownership updated to the new UID.
13+
14+
Files outside the user's home directory are not updated and must be changed
15+
manually. Note that changing a UID can be unsafe if files on the system are
16+
still owned by the original UID: those files may become accessible to a different
17+
account that is later assigned that UID. To change ownership of all files on the
18+
system from the old UID to the new UID, run:
19+
20+
sudo chown -R --from OLD_UID NEW_UID /
21+
22+
This command requires root privileges.
23+
24+
```
25+
authctl user set-uid <name> <uid> [flags]
26+
```
27+
28+
### Examples
29+
30+
```
31+
# Set the UID of user "alice" to 15000
32+
authctl user set-uid alice 15000
33+
```
34+
35+
### Options
36+
37+
```
38+
-h, --help help for set-uid
39+
```
40+
41+
### SEE ALSO
42+
43+
* [authctl user](authctl_user.md) - Commands related to users
44+

docs/cli/authctl_user_unlock.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## authctl user unlock
2+
3+
Unlock (enable) a user managed by authd
4+
5+
```
6+
authctl user unlock <user> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for unlock
13+
```
14+
15+
### SEE ALSO
16+
17+
* [authctl user](authctl_user.md) - Commands related to users
18+

0 commit comments

Comments
 (0)