Document the pleroma.emoji task

1 files changed, 43 insertions, 1 deletions

diff --git a/lib/mix/tasks/pleroma/emoji.ex b/lib/mix/tasks/pleroma/emoji.ex
index f4da183ad..0a1bf24e2 100644
--- a/lib/mix/tasks/pleroma/emoji.ex
+++ b/lib/mix/tasks/pleroma/emoji.ex
@@ -5,8 +5,50 @@
 defmodule Mix.Tasks.Pleroma.Emoji do
   use Mix.Task
 
-  @shortdoc "Manages Pleroma instance"
+  @shortdoc "Manages emoji packs"
   @moduledoc """
+  Manages emoji packs
+
+  ## ls-packs
+
+  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
+
+  mix pleroma.emoji get-packs [OPTION...] PACKS
+
+  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
+
+  ## gen-pack
+
+  mix pleroma.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 MD5 signature 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.
+
+  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).
+
   """
 
   @default_manifest Pleroma.Config.get!([:emoji, :default_manifest])