update manual

This commit is contained in:
Dan Anglin 2024-08-15 17:59:16 +01:00
parent 5df820fb29
commit fcc91ed788
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638

View file

@ -423,10 +423,28 @@ enbas show --type status --status-id 01J1Z9PT0243JT9QNQ5W96Z8CA
--poll-option "other (please comment)" --poll-option "other (please comment)"
``` ```
![A screenshot of a status with a poll](../assets/images/created_poll.png "A status with a poll") ![A screenshot of a status with a poll](../assets/images/created_poll.png "A status with a poll")
- Create a status with a media attachment that you own.
```
enbas create \
--type status \
--attachment-id 01J5BDHYJ7MWMMG76FP49H7SWD \
--content "I went out for a walk in the woods and found this interesting looking wooden bench."
```
- Upload and attach 4 media files to a new status. The number of `media-description` and `media-focus` flags **must** match the number of `media-file` flags defined.
The first `media-description` and `media-focus` flags correspond to the value defined in the first `media-file` flag and so on.
```
enbas create --type status --visibility public \
--content "This post has a picture of a cat, a dog, a bee and a bird." \
--media-file cat.jpg --media-description file@cat.txt --media-focus "0,0" \
--media-file dog.jpg --media-description file@dog.txt --media-focus "-0.1,0.25" \
--media-file bee.jpg --media-description file@bee.txt --media-focus "1,1" \
--media-file bird.webp --media-description file@bird.txt --media-focus "0,0"
```
| flag | type | required | description | default | | flag | type | required | description | default |
|------|------|----------|-------------|---------| |------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to create.<br>Here this should be `status`. | | | `type` | string | true | The resource you want to create.<br>Here this should be `status`. | |
| `attachment-id` | string | false | The ID of the media attachment to attach to the status.<br>Use this flag multiple times to attach multiple media. |
| `content` | string | false | The content of the status.<br>This flag takes precedence over `from-file`.| | | `content` | string | false | The content of the status.<br>This flag takes precedence over `from-file`.| |
| `content-type` | string | false | The format that the content is created in.<br>Valid values are `plain` and `markdown`. | plain | | `content-type` | string | false | The format that the content is created in.<br>Valid values are `plain` and `markdown`. | plain |
| `enable-reposts` | boolean | false | The status can be reposted (boosted) by others. | true | | `enable-reposts` | boolean | false | The status can be reposted (boosted) by others. | true |
@ -436,6 +454,9 @@ enbas show --type status --status-id 01J1Z9PT0243JT9QNQ5W96Z8CA
| `from-file` | string | false | The path to the file where to read the contents of the status from. | | | `from-file` | string | false | The path to the file where to read the contents of the status from. | |
| `in-reply-to` | string | false | The ID of the status that you want to reply to. | | | `in-reply-to` | string | false | The ID of the status that you want to reply to. | |
| `language` | string | false | The ISO 639 language code that the status is written in.<br>If this is not specified then the default language from your posting preferences will be used. | | | `language` | string | false | The ISO 639 language code that the status is written in.<br>If this is not specified then the default language from your posting preferences will be used. | |
| `media-file` | string | false | The path to the media file.<br>Use this flag multiple times to upload multiple media files. | |
| `media-description` | string | false | The description of the media attachment which will be used as the media's alt-text.<br>To use a description from a text file, use the `flag@` prefix followed by the path to the file (e.g. `file@description.txt`)<br>Use this flag multiple times to set multiple descriptions.| |
| `media-focus` | string | false | The media's focus values. This should be in the form of two comma-separated numbers between -1 and 1 (e.g. 0.25,-0.34).<br>Use this flag multiple times to set multiple focus values. | |
| `sensitive` | string | false | The status should be marked as sensitive.<br>If this is not specified then the default sensitivity from your posting preferences will be used. | | | `sensitive` | string | false | The status should be marked as sensitive.<br>If this is not specified then the default sensitivity from your posting preferences will be used. | |
| `spoiler-text` | string | false | The text to display as the status' warning or subject. | | | `spoiler-text` | string | false | The text to display as the status' warning or subject. | |
| `visibility` | string | false | The visibility of the status.<br>Valid values are `public`, `private`, `unlisted`, `mutuals_only` and `direct`.<br>If this is not specified then the default visibility from your posting preferences will be used. | | | `visibility` | string | false | The visibility of the status.<br>Valid values are `public`, `private`, `unlisted`, `mutuals_only` and `direct`.<br>If this is not specified then the default visibility from your posting preferences will be used. | |
@ -696,7 +717,7 @@ You can write a description of the media to a text file and specify the its path
``` ```
enbas create --type media-attachment \ enbas create --type media-attachment \
--media-file picture.png \ --media-file picture.png \
--media-description "A picture of a rotten wooden bench in front of the woods." \ --media-description "A picture of an old, slanted wooden bench in front of the woods." \
--media-focus "-0.1,0.5" --media-focus "-0.1,0.5"
``` ```
- Create a media attachment using a description that has been written to the `description.txt` text file. - Create a media attachment using a description that has been written to the `description.txt` text file.