commit be85dbe60005c8301a04b8b49659a95ab00b7092
parent 1ab137c23d2199a8c96cbc21178e25524d9545e4
Author: Frederic Cambus <fred@statdns.com>
Date: Mon, 4 Jan 2016 15:18:45 +0100
Adding initial manual page in mdoc format
Diffstat:
| A | ansiweather.1 | | | 95 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 95 insertions(+), 0 deletions(-)
diff --git a/ansiweather.1 b/ansiweather.1
@@ -0,0 +1,95 @@
+.\"
+.\" Copyright (c) 2013-2016, Frederic Cambus
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are met:
+.\"
+.\" * Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\"
+.\" * Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" * Neither the name of the copyright holder nor the names of its
+.\" contributors may be used to endorse or promote products derived from
+.\" this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
+.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: January 4 2016 $
+.Dt ANSIWEATHER 1
+.Os
+.Sh NAME
+.Nm ansiweather
+.Nd weather in terminal, with ANSI colors and Unicode symbols
+.Sh SYNOPSIS
+.Nm
+.Op Fl Fh
+.Op Fl a Ar value
+.Op Fl d Ar value
+.Op Fl f Ar days
+.Op Fl k Ar key
+.Op Fl l Ar location
+.Op Fl s Ar value
+.Op Fl u Ar system
+.Sh DESCRIPTION
+.Nm
+is a shell script for displaying the current weather
+conditions in a terminal, with support for ANSI colors and Unicode
+symbols.
+.Pp
+Weather data comes from the OpenWeatherMap free weather API.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl a Ar value
+Toggle ANSI colors display (
+.Ar true
+or
+.Ar false
+)
+.It Fl d Ar value
+Toggle daylight data display (
+.Ar true
+or
+.Ar false
+)
+.It Fl f Ar days
+Toggle forecast mode for the specified number of upcoming days
+.It Fl F
+Toggle forecast mode for the next five days
+.It Fl h
+Display help
+.It Fl k Ar key
+Specify API key
+.It Fl l Ar location
+Specify location
+.It Fl s Ar value
+Toggle symbols display (
+.Ar true
+or
+.Ar false
+)
+.It Fl u Ar system
+Specify unit system to use (
+.Ar metric
+or
+.Ar imperial
+)
+.El
+.Sh AUTHORS
+.Nm
+was written by
+.An Frederic Cambus
