CLI_tasks: Use manpage formatting conventions

- [] for options
- <> for mandatory arguments
- foo ... when foo can be repeated

[ci skip]
This commit is contained in:
Haelwenn (lanodan) Monnier 2020-03-11 08:46:57 +01:00
commit 6316726a5f
No known key found for this signature in database
GPG key ID: D5B7A8E43C997DEE
6 changed files with 20 additions and 20 deletions

View file

@ -5,11 +5,11 @@
## Create a user
```sh tab="OTP"
./bin/pleroma_ctl user new <nickname> <email> [<options>]
./bin/pleroma_ctl user new <nickname> <email> [option ...]
```
```sh tab="From Source"
mix pleroma.user new <nickname> <email> [<options>]
mix pleroma.user new <nickname> <email> [option ...]
```
@ -33,11 +33,11 @@ mix pleroma.user list
## Generate an invite link
```sh tab="OTP"
./bin/pleroma_ctl user invite [<options>]
./bin/pleroma_ctl user invite [option ...]
```
```sh tab="From Source"
mix pleroma.user invite [<options>]
mix pleroma.user invite [option ...]
```
@ -137,11 +137,11 @@ mix pleroma.user reset_password <nickname>
## Set the value of the given user's settings
```sh tab="OTP"
./bin/pleroma_ctl user set <nickname> [<options>]
./bin/pleroma_ctl user set <nickname> [option ...]
```
```sh tab="From Source"
mix pleroma.user set <nickname> [<options>]
mix pleroma.user set <nickname> [option ...]
```
### Options