ansiweather

Weather in terminal, with ANSI colors and Unicode symbols
Log | Files | Refs | README | LICENSE

ansiweather.1 (3137B)


      1 .\"
      2 .\" Copyright (c) 2013-2020, Frederic Cambus
      3 .\" All rights reserved.
      4 .\"
      5 .\" Redistribution and use in source and binary forms, with or without
      6 .\" modification, are permitted provided that the following conditions are met:
      7 .\"
      8 .\"   * Redistributions of source code must retain the above copyright
      9 .\"     notice, this list of conditions and the following disclaimer.
     10 .\"
     11 .\"   * Redistributions in binary form must reproduce the above copyright
     12 .\"     notice, this list of conditions and the following disclaimer in the
     13 .\"     documentation and/or other materials provided with the distribution.
     14 .\"
     15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     16 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
     19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     25 .\" POSSIBILITY OF SUCH DAMAGE.
     26 .\"
     27 .Dd $Mdocdate: January 16 2020 $
     28 .Dt ANSIWEATHER 1
     29 .Os
     30 .Sh NAME
     31 .Nm ansiweather
     32 .Nd weather in terminal, with ANSI colors and Unicode symbols
     33 .Sh SYNOPSIS
     34 .Nm
     35 .Op Fl F
     36 .Op Fl l Ar location
     37 .Op Fl u Ar system
     38 .Op Fl f Ar days
     39 .Op Fl a Ar value
     40 .Op Fl s Ar value
     41 .Op Fl k Ar key
     42 .Op Fl i Ar value
     43 .Op Fl w Ar value
     44 .Op Fl h Ar value
     45 .Op Fl p Ar value
     46 .Op Fl d Ar value
     47 .Op Fl v Ar value
     48 .Sh DESCRIPTION
     49 .Nm
     50 is a shell script for displaying the current weather
     51 conditions in a terminal, with support for ANSI colors and Unicode
     52 symbols.
     53 .Pp
     54 Weather data comes from the OpenWeatherMap free weather API.
     55 .Pp
     56 The options are as follows:
     57 .Bl -tag -width Ds
     58 .It Fl l Ar location
     59 Specify location.
     60 .It Fl u Ar system
     61 Specify unit system to use (
     62 .Ar metric
     63 or
     64 .Ar imperial
     65 ).
     66 .It Fl f Ar days
     67 Toggle forecast mode for the specified number of upcoming days.
     68 .It Fl F
     69 Toggle forecast mode for the next five days.
     70 .It Fl a Ar value
     71 Toggle ANSI colors display (
     72 .Ar true
     73 or
     74 .Ar false
     75 ).
     76 .It Fl s Ar value
     77 Toggle symbols display (
     78 .Ar true
     79 or
     80 .Ar false
     81 ).
     82 .It Fl k Ar key
     83 Specify OpenWeatherMap API key.
     84 .It Fl i Ar value
     85 Toggle UV Index display (
     86 .Ar true
     87 or
     88 .Ar false
     89 ).
     90 .It Fl w Ar value
     91 Toggle wind data display (
     92 .Ar true
     93 or
     94 .Ar false
     95 ).
     96 .It Fl h Ar value
     97 Toggle humidity data display (
     98 .Ar true
     99 or
    100 .Ar false
    101 ).
    102 .It Fl p Ar value
    103 Toggle pressure data display (
    104 .Ar true
    105 or
    106 .Ar false
    107 ).
    108 .It Fl d Ar value
    109 Toggle daylight data display (
    110 .Ar true
    111 or
    112 .Ar false
    113 ).
    114 .It Fl v
    115 Display version.
    116 .El
    117 .Sh EXAMPLES
    118 Display forecast using metric units for the next five days (showing
    119 symbols and daylight data) for Rzeszow, Poland:
    120 .Pp
    121 ansiweather -l Rzeszow,PL -u metric -s true -f 5 -d true
    122 .Sh AUTHORS
    123 .Nm
    124 was written by
    125 .An Frederic Cambus .