golang/mikael/madonctl: comparison README.md

equal deleted inserted replaced

-:2416123fef25
+:093fc00b333d
 usually provide an account login/password (or a token).
 These settings can be passed as command line arguments or environment variables,
 but the easiest way is to use a configuration file.
-Note that you can *generate a configuration file* for your settings with
+Note that you can **generate a configuration file** for your settings with
 `madonctl config dump -i mastodon.social -L username@domain -P password`
 (You can redirect the output to a configuration file.)
 ... or read message from standard input:
 ```
 % echo "Hello from #madonctl" | madonctl toot --stdin
 ```
-Some *account-related commands*:
+Some **account-related commands**:
 ``` sh
 % madonctl accounts blocked                       # List blocked accounts
 % madonctl accounts muted                         # List muted accounts
 % madonctl accounts notifications --list --all    # List really all notifications
 % madonctl accounts notifications --list --clear  # List and clear notifications
 Note: By default, madonctl will send a single query.  If you want all available
 results you should use the `--all` flag.  If you use a `--limit` value,
 madonctl might send several queries until the number of results reaches this
 value.
-Update your account information:
+**Update** your account information:
 ``` sh
 % madonctl accounts update --display-name "John"  # Update display name
 % madonctl accounts update --note "Newcomer"      # Update user note (bio)
 % madonctl accounts update --note ""              # Clear note
 % madonctl accounts update --avatar me.png        # Update avatar
 % madonctl accounts following                     # See last following
 % madonctl accounts following --all               # See all followed accounts
 % madonctl accounts followers --limit 30          # Last 30 followers
 ```
-Add/remove a *favourite*, *boost* a status...
+Add/remove a **favourite**, **boost** a status...
 ``` sh
 % madonctl status --status-id 416671 favourite    # Fave a status
 % madonctl status --status-id 416671 boost        # Boost a status
 ```
 Search for an account (only accounts known to your instance):
 ``` sh
 % madonctl accounts search gargron
 ```
-*Follow* an account with known ID:
+**Follow** an account with known ID:
 ``` sh
 % madonctl accounts follow --account-id 1234
 ```
 Follow a remote account:
 ``` sh
 % madonctl accounts follow --remote Gargron@mastodon.social
 ```
-*Search* for accounts, statuses or hashtags:
+**Search** for accounts, statuses or hashtags:
 ``` sh
 % madonctl search gargron
 % madonctl search mastodon
 ```
 ``` sh
 % madonctl accounts --user-id Gargron@mastodon.social -l5 # Last 5 statuses
 % madonctl accounts --user-id https://mastodon.social/@Gargron -l5 # Same
 ```
-Read *timelines*:
+Read **timelines**:
 ``` sh
 % madonctl timeline                 # Display home timeline
 % madonctl timeline public          # Display federated timeline
 % madonctl timeline public --local  # Display public local timeline
 % madonctl timeline --limit 3       # Display 3 latest home timeline messages
 ```
-Use the *streaming API* and fetch timelines and notifications:
+Use the **streaming API** and fetch timelines and notifications:
 ``` sh
 % madonctl stream                   # Stream home timeline and notifications
 % madonctl stream local             # Stream local timeline
 % madonctl stream public            # Stream federated timeline
 ```
-You can also use *hashtag streams*:
+You can also use **hashtag streams**:
 ``` sh
 % madonctl stream :mastodon         # Stream for hastag 'mastodon'
 % madonctl stream :madonctl,golang  # Stream for several hashtags
 ```
 Please note that madonctl will use one socket per stream, so the number of
 concurrent hashtags is currently limited to 4 for "politeness".
-(Almost) All commands have a *customisable output*:
+(Almost) All commands have a **customisable output**:
 ``` sh
 % madonctl accounts show            # Display an account
 % madonctl accounts show -o yaml    # Display an account, in yaml
 % madonctl accounts show -o json    # Display an account, in json
 % madonctl stream local -o json     # Stream local timeline and output to JSON
 ```
-You can also use Go (Golang) *templates*:
+You can also use Go (Golang) **templates**:
 ``` sh
 % madonctl accounts --account-id 1 followers --template '{{.acct}}{{"\n"}}'
 ```
 Number of users on current instance (statistics from instances.mastodon.xyz API):
 There are many more commands, you can find them in the online help or the manpage.
 ### Shell completion
-If you want *shell completion*, you can generate scripts with the following command: \
+If you want **shell completion**, you can generate scripts with the following command: \
 `madonctl completion bash` (or zsh)
 Then, just source the script in your shell.
 For example, I have this line in my .zshrc:
 `source <(madonctl completion zsh)`
 ### Commands output
-The output can be set to *json*, *yaml* or to a *Go template* for all commands.\
+The output can be set to **json**, **yaml** or to a **Go template** for all commands.\
 If you are familiar with Kubernetes' kubectl, it is very similar.
 For example, you can display your user token with:\
 `madonctl config whoami --template '{{.access_token}}'`\
 or the application ID with:\
 `madonctl config dump --template '{{.ID}}'`
 All the users that have favorited a given status:\
 `madonctl status --status-id 101194 favourited-by --template '{{.username}}{{"\n"}}'`
-Sets of templates can be grouped as *themes*.
+Sets of templates can be grouped as **themes**.
 For more complex templates, one can use the `--template-file` option.\
 See the [themes & templates](templates) folder.
 ## References

changeset 107	093fc00b333d
parent 105	07d96d963223
child 108	cc73f7cb0f21