Skip to content

Commit af0db66

Browse files
committed
docs(plugin-command): improve formatting and add spacing for clarity in command usage sections
1 parent 226565b commit af0db66

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/plugin-command.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 7
88

99
The `plugin` command is the CLI tool for managing Unraid plugins. It handles installation, updates, removal, and status checks.
1010

11-
```
11+
```text
1212
Usage: plugin install PLUGIN-FILE [forced]
1313
plugin remove PLUGIN
1414
plugin check PLUGIN
@@ -43,6 +43,7 @@ plugin install /path/to/myplugin.plg forced
4343
```
4444

4545
**What happens:**
46+
4647
1. Downloads the PLG file (if URL)
4748
2. Processes all `<FILE>` elements with `install` method
4849
3. Copies PLG to `/boot/config/plugins/`
@@ -69,6 +70,7 @@ plugin remove myplugin.plg
6970
```
7071

7172
**What happens:**
73+
7274
1. Processes all `<FILE>` elements with `remove` method
7375
2. Deletes symlink from `/var/log/plugins/`
7476
3. Moves PLG to `/boot/config/plugins-removed/`
@@ -82,6 +84,7 @@ plugin check myplugin.plg
8284
```
8385

8486
**What happens:**
87+
8588
1. Downloads PLG from `pluginURL` to `/tmp/plugins/`
8689
2. Extracts and outputs the version string
8790
3. Exits 0 if newer version available
@@ -115,6 +118,7 @@ plugin update myplugin.plg
115118
```
116119

117120
**What happens:**
121+
118122
1. Looks for new PLG in `/tmp/plugins/`
119123
2. Runs install method of new version
120124
3. Replaces old PLG in `/boot/config/plugins/`
@@ -142,7 +146,7 @@ plugin pluginURL /var/log/plugins/myplugin.plg
142146
## Directory Reference
143147

144148
| Directory | Purpose |
145-
|-----------|---------|
149+
| --------- | ------- |
146150
| `/boot/config/plugins/` | Active plugin PLG files |
147151
| `/boot/config/plugins-error/` | Failed installations |
148152
| `/boot/config/plugins-removed/` | Uninstalled plugins |
@@ -203,6 +207,7 @@ plugin install myplugin.plg 2>&1 | tee /tmp/install.log
203207
### Plugin Moved to plugins-error
204208

205209
Installation failed. Check:
210+
206211
1. MD5 checksum mismatches
207212
2. Download failures
208213
3. Script errors
@@ -266,7 +271,7 @@ echo "Author: $(plugin author $PLG)"
266271
<details markdown="block">
267272
<summary>Complete <code>plugin</code> command help output</summary>
268273

269-
```
274+
```text
270275
Process plugin files.
271276
272277
Usage: plugin install PLUGIN-FILE [forced]

0 commit comments

Comments
 (0)