diff --git a/docs/manual.md b/docs/manual.md index 3c44007..c375942 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -28,6 +28,10 @@ - [View your follow requests](#view-your-follow-requests) - [Accept a follow request](#accept-a-follow-request) - [Reject a follow request](#reject-a-follow-request) +- [Media Attachments](#media-attachments) + - [Create a media attachment](#create-a-media-attachment) + - [Edit a media attachment](#edit-a-media-attachment) + - [View a media attachment](#view-a-media-attachment) - [Statuses](#statuses) - [View a status](#view-a-status) - [Create a status](#create-a-status) @@ -54,10 +58,6 @@ - [Remove accounts from a list](#remove-accounts-from-a-list) - [Timelines](#timelines) - [View a timeline](#view-a-timeline) -- [Media Attachments](#media-attachments) - - [Create a media attachment](#create-a-media-attachment) - - [Edit a media attachment](#edit-a-media-attachment) - - [View a media attachment](#view-a-media-attachment) - [Media](#media) - [View media from a status](#view-media-from-a-status) - [Bookmarks](#bookmarks) @@ -372,6 +372,64 @@ enbas reject --type follow-request --account-name @person.example.social | `type` | string | true | The resource you want to accept.
Here this should be `follow-request`. | | | `account-name` | string | true | The name of the account that you want to reject. | | +## Media Attachments + +### Create a media attachment + +Uploads media from a file to the instance and creates a media attachment. +You can write a description of the media to a text file and specify the its path with the `media-description` flag (see the examples below). + +- Create a media attachment with a simple description and a focus of x=-0.1, y=0.5 + ``` + enbas create --type media-attachment \ + --media-file picture.png \ + --media-description "A picture of an old, slanted wooden bench in front of the woods." \ + --media-focus "-0.1,0.5" + ``` +- Create a media attachment using a description that has been written to the `description.txt` text file. + ``` + enbas create --type media-attachment \ + --media-file picture.png \ + --media-description file@description.txt + ``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to create.
Here this should be `media-attachment`. | | +| `media-file` | string | true | The path to the media file. | | +| `media-description` | string | false | The description of the media attachment which will be used as the media's alt-text.
To use a description from a text file, use the `flag@` prefix followed by the path to the file (e.g. `file@description.txt`)| | +| `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) | | + +### Edit a media attachment + +Edits the description and/or the focus of a media attachment that you own. + +``` +enbas edit --type media-attachment \ + --attachment-id 01J5B9A8WFK59W11MS6AHPYWBR \ + --media-description "An updated description of a picture." +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to edit.
Here this should be `media-attachment`. | | +| `media-description` | string | false | The description of the media attachment to edit.
To use a description from a text file, use the `flag@` prefix followed by the path to the file (e.g. `file@description.txt`)| | +| `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) | | + +### View a media attachment + +Prints information about a given media attachment that you own. +You can only see information about the media attachment that you own. + +``` +enbas show --type media-attachment --attachment-id 01J0N0RQSJ7CFGKHA30F7GBQXT +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to view.
Here this should be `media`. | | +| `attachment-id` | string | true | The ID of the media attachment to view. | | + ## Statuses ### View a status @@ -706,64 +764,6 @@ Prints a list of statuses from a timeline. | `tag` | string | false | The hashtag you want to view.
This is only required if `timeline-category` is set to `tag`. | | | `limit` | integer | false | The maximum number of statuses to print. | 20 | -## Media Attachments - -### Create a media attachment - -Uploads media from a file to the instance and creates a media attachment. -You can write a description of the media to a text file and specify the its path with the `media-description` flag (see the examples below). - -- Create a media attachment with a simple description and a focus of x=-0.1, y=0.5 - ``` - enbas create --type media-attachment \ - --media-file picture.png \ - --media-description "A picture of an old, slanted wooden bench in front of the woods." \ - --media-focus "-0.1,0.5" - ``` -- Create a media attachment using a description that has been written to the `description.txt` text file. - ``` - enbas create --type media-attachment \ - --media-file picture.png \ - --media-description file@description.txt - ``` - -| flag | type | required | description | default | -|------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to create.
Here this should be `media-attachment`. | | -| `media-file` | string | true | The path to the media file. | | -| `media-description` | string | false | The description of the media attachment which will be used as the media's alt-text.
To use a description from a text file, use the `flag@` prefix followed by the path to the file (e.g. `file@description.txt`)| | -| `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) | | - -### Edit a media attachment - -Edits the description and/or the focus of a media attachment that you own. - -``` -enbas edit --type media-attachment \ - --attachment-id 01J5B9A8WFK59W11MS6AHPYWBR \ - --media-description "An updated description of a picture." -``` - -| flag | type | required | description | default | -|------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to edit.
Here this should be `media-attachment`. | | -| `media-description` | string | false | The description of the media attachment to edit.
To use a description from a text file, use the `flag@` prefix followed by the path to the file (e.g. `file@description.txt`)| | -| `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) | | - -### View a media attachment - -Prints information about a given media attachment that you own. -You can only see information about the media attachment that you own. - -``` -enbas show --type media-attachment --attachment-id 01J0N0RQSJ7CFGKHA30F7GBQXT -``` - -| flag | type | required | description | default | -|------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to view.
Here this should be `media`. | | -| `attachment-id` | string | true | The ID of the media attachment to view. | | - ## Media ### View media from a status