]> git.ipfire.org Git - people/ms/network.git/blobdiff - man/include-description.txt
man: Convert network-description(8) to asciidoc
[people/ms/network.git] / man / include-description.txt
diff --git a/man/include-description.txt b/man/include-description.txt
new file mode 100644 (file)
index 0000000..a39ba55
--- /dev/null
@@ -0,0 +1,11 @@
+'description edit'::
+       This command opens an editor and allows you to edit title and description.
+
+       NOTE: The formation of the description is similar to a git commit.
+       Every description has a title, the first line of the description.
+       The title is shown on the status page and in the web user interface.
+       It should be something short like "Office Lan" or "DMZ".
+       After the title can follow a longer description.
+
+'description show'::
+       Prints the description.