summaryrefslogtreecommitdiff
path: root/example.1.in
diff options
context:
space:
mode:
authorLars Wirzenius <liw@evil.liw.fi>2011-05-23 14:25:44 +0100
committerLars Wirzenius <liw@evil.liw.fi>2011-05-23 14:25:44 +0100
commit7f24e23ac394d70980ebd8bdbf908a0020660a09 (patch)
treef8f227df7cdebaa10b86db5f9daac530c9a05aa9 /example.1.in
parentef01f356ea258a21860a87d8bff0be3b83951241 (diff)
downloadcliapp-7f24e23ac394d70980ebd8bdbf908a0020660a09.tar.gz
Add sample manpage template for example.py.
Diffstat (limited to 'example.1.in')
-rw-r--r--example.1.in30
1 files changed, 30 insertions, 0 deletions
diff --git a/example.1.in b/example.1.in
new file mode 100644
index 0000000..d9228d2
--- /dev/null
+++ b/example.1.in
@@ -0,0 +1,30 @@
+.\" Copyright 2011 Lars Wirzenius <liw@liw.fi>
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH EXAMPLE.PY 1
+.SH NAME
+example.py \- cliapp-based simplistic fgrep clone
+.SH SYNOPSIS
+.SH DESCRIPTION
+.B example.py'
+is an example program for
+.BR cliapp ,
+a Python framework for command line utilities.
+.SH OPTIONS
+.SH EXAMPLE
+To find a pattern in a file:
+.IP
+python example.py --pattern=needle haystack.txt
+