diff options
author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-05-15 03:13:25 -0500 |
---|---|---|
committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-05-15 03:13:25 -0500 |
commit | 250e9965add22337c200b4b80dfba4b6ac21bce0 (patch) | |
tree | 469409b465fbe7930dddd5aed6481e11b74c6d4a /devel | |
parent | 46af8229026a6122ca640f063c24d68876acdb11 (diff) | |
download | horizon-250e9965add22337c200b4b80dfba4b6ac21bce0.tar.gz horizon-250e9965add22337c200b4b80dfba4b6ac21bce0.tar.bz2 horizon-250e9965add22337c200b4b80dfba4b6ac21bce0.tar.xz horizon-250e9965add22337c200b4b80dfba4b6ac21bce0.zip |
devel: Add template manpage for future maintenance
Diffstat (limited to 'devel')
-rw-r--r-- | devel/template.8 | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/devel/template.8 b/devel/template.8 new file mode 100644 index 0000000..8f40c96 --- /dev/null +++ b/devel/template.8 @@ -0,0 +1,48 @@ +.Dd May 15, 2020 +.Dt <TOOL-NAME> 8 +.Os "Adélie Linux" +.Sh NAME +.Nm <tool-name> +.Nd <short description of the tool's purpose> +.Sh SYNOPSIS +.Nm +.Op Fl a Ar ARGUMENT +.Op Fl f +.Sh DESCRIPTION +.Nm +does something. +.Bl -tag -width "-v VERSION" -offset indent -compact +.It Fl a Ar ARGUMENT +Specifies an argument to the tool. +.It Fl f +Sets a flag in the tool. +.Ss Sub-section +The +.Nm +utility does other things. +.Sh ENVIRONMENT +.Bl -tag -width "LONG_ENV_VAR" -offset indent -compact +.It Ev Sy ENV_VAR +Controls a behaviour of the tool. +.It Ev Sy LONG_ENV_VAR +Controls another behaviour. +.Sh FILES +.Bl -ohang -width "/etc/foo" -offset indent -compact +.It Pa /etc/foo +.Nm +reads the /etc/foo file for foos. +.Sh EXAMPLES +tool-name -f +.Pp +LONG_ENV_VAR=bar tool-name +.Sh SEE ALSO +.Xr mksquashfs 1 , +.Xr apk 8 , +.Xr mkisofs 8 . +.Sh HISTORY +The +.Nm +command first appeared in Horizon 1.0. +.Sh AUTHORS +.An A. Wilcox +.Aq awilfox@adelielinux.org |