ansiweather

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

ansiweather.1 (3219B)


      1 .\"
      2 .\" Copyright (c) 2013-2021, 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: September 14 2021 $
     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 l Ar location
     36 .Op Fl u Ar system
     37 .Op Fl f Ar days
     38 .Op Fl F
     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 H Ar value
     46 .Op Fl p Ar value
     47 .Op Fl d Ar value
     48 .Op Fl v
     49 .Sh DESCRIPTION
     50 .Nm
     51 is a shell script for displaying the current weather
     52 conditions in a terminal, with support for ANSI colors and Unicode
     53 symbols.
     54 .Pp
     55 Weather data comes from the OpenWeatherMap free weather API.
     56 .Pp
     57 The options are as follows:
     58 .Bl -tag -width Ds
     59 .It Fl l Ar location
     60 Specify location.
     61 .It Fl u Ar system
     62 Specify unit system to use (
     63 .Ar metric
     64 or
     65 .Ar imperial
     66 ).
     67 .It Fl f Ar days
     68 Toggle forecast mode for the specified number of upcoming days.
     69 .It Fl F
     70 Toggle forecast mode for the next five days.
     71 .It Fl a Ar value
     72 Toggle ANSI colors display (
     73 .Ar true
     74 or
     75 .Ar false
     76 ).
     77 .It Fl s Ar value
     78 Toggle symbols display (
     79 .Ar true
     80 or
     81 .Ar false
     82 ).
     83 .It Fl k Ar key
     84 Specify OpenWeatherMap API key.
     85 .It Fl i Ar value
     86 Toggle UV Index display (
     87 .Ar true
     88 or
     89 .Ar false
     90 ).
     91 .It Fl w Ar value
     92 Toggle wind data display (
     93 .Ar true
     94 or
     95 .Ar false
     96 ).
     97 .It Fl h Ar value
     98 Toggle humidity data display (
     99 .Ar true
    100 or
    101 .Ar false
    102 ).
    103 .It Fl H Ar value
    104 Toggle Feels like display (
    105 .Ar true
    106 or
    107 .Ar false
    108 ).
    109 .It Fl p Ar value
    110 Toggle pressure data display (
    111 .Ar true
    112 or
    113 .Ar false
    114 ).
    115 .It Fl d Ar value
    116 Toggle daylight data display (
    117 .Ar true
    118 or
    119 .Ar false
    120 ).
    121 .It Fl v
    122 Display version.
    123 .El
    124 .Sh EXAMPLES
    125 Display forecast using metric units for the next five days (showing
    126 symbols and daylight data) for Rzeszow, Poland:
    127 .Pp
    128 ansiweather -l Rzeszow,PL -u metric -s true -f 5 -d true
    129 .Sh AUTHORS
    130 .Nm
    131 was written by
    132 .An Frederic Cambus .