aboutsummaryrefslogtreecommitdiff
path: root/doc/nowopen.1
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2019-01-22 23:35:33 -0800
committerBruce Hill <bruce@bruce-hill.com>2019-01-22 23:35:33 -0800
commit8449110c67b71f87784169c1d313bbf0857c848a (patch)
tree656f024d7eca8ff36046c033377ff08e7c9d58d7 /doc/nowopen.1
parent73cdfa4e91342efc38875133dc2236afc4f4b731 (diff)
Added manfile
Diffstat (limited to 'doc/nowopen.1')
-rw-r--r--doc/nowopen.134
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/nowopen.1 b/doc/nowopen.1
new file mode 100644
index 0000000..e0e2c4a
--- /dev/null
+++ b/doc/nowopen.1
@@ -0,0 +1,34 @@
+.\" Manpage for nowopen.
+.\" Contact bruce@bruce-hill.com to correct errors or typos.
+.TH man 8 "5 January 2019" "1.0" "nowopen man page"
+.SH NAME
+nowopen \- Display which businesses are now open.
+.SH SYNOPSIS
+\fBnowopen\fR [ \fI-p\fR ] [ \fI--help\fR ] [ \fItags...\fR ]
+.SH DESCRIPTION
+\fBnowopen\fR will display currently open businesses and how long until they
+close. It uses data from either \fB~/.local/share/nowopen/businesshours\fR
+or \fB~/.businesshours\fR.
+
+.SH OPTIONS
+.TP
+.B \-p
+Display output in plain text to stdout instead of using a temporary display
+with color.
+.TP
+.B \--help
+Print the command line usage.
+.TP
+.B tags
+If provided, only show business hours of places that match one of the provided
+tags (prefix matching is used).
+
+.SH EXAMPLES
+.TP
+.B nowopen -p pizza
+.TP
+.B output:
+Jimmy Pesto's Pizzeria: 9:14 left
+
+.SH AUTHOR
+Bruce Hill (bruce@bruce-hill.com)