Browse code

Add markdown for man page of `docker plugin ls`

This fix adds markdown for man page of `docker plugin ls`,
based on https://github.com/docker/docker/pull/28627#issuecomment-276731752

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>

Yong Tang authored on 2017/02/02 04:28:12
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,43 @@
0
+Lists all the plugins that are currently installed. You can install plugins
1
+using the `docker plugin install` command.
2
+You can also filter using the `-f` or `--filter` flag.
3
+
4
+## Filters
5
+
6
+Filter output based on these conditions:
7
+   - enabled=(true|false) - plugins that are enabled or not
8
+   - capability=<string> - filters plugins based on capabilities (currently `volumedriver`, `networkdriver`, `ipamdriver`, or `authz`)
9
+
10
+## Format
11
+
12
+   Pretty-print plugins using a Go template.
13
+   Valid placeholders:
14
+      .ID - Plugin ID.
15
+      .Name - Plugin Name.
16
+      .Description - Plugin description.
17
+      .Enabled - Whether plugin is enabled or not.
18
+
19
+# EXAMPLES
20
+## Display all plugins
21
+
22
+    $ docker plugin ls
23
+    ID                  NAME                                    DESCRIPTION                         ENABLED
24
+    869080b57404        tiborvass/sample-volume-plugin:latest   A sample volume plugin for Docker   true
25
+    141bf6c02ddd        vieux/sshfs:latest                      sshFS plugin for Docker             false
26
+
27
+## Display plugins with their ID and names
28
+
29
+    $ docker plugin ls --format "{{.ID}}: {{.Name}}"
30
+    869080b57404: tiborvass/sample-volume-plugin:latest
31
+
32
+## Display enabled plugins
33
+
34
+    $ docker plugin ls --filter enabled=true
35
+    ID                  NAME                                    DESCRIPTION                         ENABLED
36
+    869080b57404        tiborvass/sample-volume-plugin:latest   A sample volume plugin for Docker   true
37
+
38
+## Display plguins with `volumedriver` capability
39
+
40
+    $ docker plugin ls --filter capability=volumedriver --format "table {{.ID}}\t{{.Name}}"
41
+    ID                  Name
42
+    869080b57404        tiborvass/sample-volume-plugin:latest