Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop

[akkoma] / docs / administration / CLI_tasks / emoji.md

diff --git a/docs/administration/CLI_tasks/emoji.md b/docs/administration/CLI_tasks/emoji.md
index 39216a897692fc05972e465d5d11749f4a6abe6d..ddcb7e62c4c56fde1abd126bac25f676a709d28a 100644 (file)
--- a/docs/administration/CLI_tasks/emoji.md
+++ b/docs/administration/CLI_tasks/emoji.md
@@ -1,33 +1,54 @@
 # Managing emoji packs
 
-Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl emoji` and in case of source installs it's `mix pleroma.emoji`.
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
 
-## `ls-packs`
+## Lists emoji packs and metadata specified in the manifest
 
-```sh
-$PREFIX ls-packs [OPTION...]
+```sh tab="OTP"
+./bin/pleroma_ctl emoji ls-packs [option ...]
+```
+
+```sh tab="From Source"
+mix pleroma.emoji ls-packs [option ...]
 ```
 
-Lists the emoji packs and metadata specified in the manifest.
 
 ### Options
 - `-m, --manifest PATH/URL` - path to a custom manifest, it can either be an URL starting with `http`, in that case the manifest will be fetched from that address, or a local path
 
-## `get-packs`
-```sh
-$PREFIX get-packs [OPTION...] PACKS
+## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME`
+
+```sh tab="OTP"
+./bin/pleroma_ctl emoji get-packs [option ...] <pack ...>
+```
+
+```sh tab="From Source"
+mix pleroma.emoji get-packs [option ...] <pack ...>
 ```
-Fetches, verifies and installs the specified PACKS from the manifest into the `STATIC-DIR/emoji/PACK-NAME`
 
 ### Options
 - `-m, --manifest PATH/URL` - same as [`ls-packs`](#ls-packs)
 
-## `gen-pack`
-```sh
-$PREFIX gen-pack PACK-URL
+## Create a new manifest entry and a file list from the specified remote pack file
+
+```sh tab="OTP"
+./bin/pleroma_ctl emoji gen-pack PACK-URL
 ```
-Creates a new manifest entry and a file list from the specified remote pack file. Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you. 
 
-  The manifest entry will either be written to a newly created `index.json` file or appended to the existing one, *replacing* the old pack with the same name if it was in the file previously.
+```sh tab="From Source"
+mix pleroma.emoji gen-pack PACK-URL
+```
+
+Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you.
+
+  The manifest entry will either be written to a newly created `pack_name.json` file (pack name is asked in questions) or appended to the existing one, *replacing* the old pack with the same name if it was in the file previously.
 
   The file list will be written to the file specified previously, *replacing* that file. You _should_ check that the file list doesn't contain anything you don't need in the pack, that is, anything that is not an emoji (the whole pack is downloaded, but only emoji files are extracted).
+
+## Reload emoji packs
+
+```sh tab="OTP"
+./bin/pleroma_ctl emoji reload
+```
+
+This command only works with OTP releases.