[people/ms/network.git] / man / include-description.txt

'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.
Commit	Line	Data
c601b69e MT	1	'description edit'::
c601b69e MT	2	This command opens an editor and allows you to edit title and description.
357723e9	3	+
c601b69e MT	4	NOTE: The formation of the description is similar to a git commit.
	5	Every description has a title, the first line of the description.
	6	The title is shown on the status page and in the web user interface.
	7	It should be something short like "Office Lan" or "DMZ".
	8	After the title can follow a longer description.
	9
	10	'description show'::
	11	Prints the description.