From 3a4773c3c2bd0bbef244eb519b07208da9108e49 Mon Sep 17 00:00:00 2001
From: dcc <dcc@logografos.com>
Date: Sat, 2 Sep 2023 00:52:52 -0700
Subject: First

---
 docs/administration/CLI_tasks/emoji.md | 61 ++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 docs/administration/CLI_tasks/emoji.md

(limited to 'docs/administration/CLI_tasks/emoji.md')

diff --git a/docs/administration/CLI_tasks/emoji.md b/docs/administration/CLI_tasks/emoji.md
new file mode 100644
index 0000000..e3d1b21
--- /dev/null
+++ b/docs/administration/CLI_tasks/emoji.md
@@ -0,0 +1,61 @@
+# Managing emoji packs
+
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+
+## Lists emoji packs and metadata specified in the manifest
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl emoji ls-packs [option ...]
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.emoji ls-packs [option ...]
+    ```
+
+
+### 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
+
+## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME`
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl emoji get-packs [option ...] <pack ...>
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.emoji get-packs [option ...] <pack ...>
+    ```
+
+### Options
+- `-m, --manifest PATH/URL` - same as [`ls-packs`](#ls-packs)
+
+## Create a new manifest entry and a file list from the specified remote pack file
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl emoji gen-pack PACK-URL
+    ```
+
+=== "From Source"
+    ```sh
+    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
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl emoji reload
+    ```
+
+This command only works with OTP releases.
-- 
cgit v1.2.3