/
ansiweather.1
132 lines (132 loc) · 3.14 KB
/
ansiweather.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
.\"
.\" Copyright (c) 2013-2023, 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.
.\"
.\" 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 COPYRIGHT HOLDER 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 7 2023 $
.Dt ANSIWEATHER 1
.Os
.Sh NAME
.Nm ansiweather
.Nd weather in terminal, with ANSI colors and Unicode symbols
.Sh SYNOPSIS
.Nm
.Op Fl l Ar location
.Op Fl u Ar system
.Op Fl f Ar days
.Op Fl F
.Op Fl a Ar value
.Op Fl s Ar value
.Op Fl k Ar key
.Op Fl i Ar value
.Op Fl w Ar value
.Op Fl h Ar value
.Op Fl H Ar value
.Op Fl p Ar value
.Op Fl d Ar value
.Op Fl v
.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 l Ar location
Specify location.
.It Fl u Ar system
Specify unit system to use (
.Ar metric
or
.Ar imperial
).
.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 a Ar value
Toggle ANSI colors display (
.Ar true
or
.Ar false
).
.It Fl s Ar value
Toggle symbols display (
.Ar true
or
.Ar false
).
.It Fl k Ar key
Specify OpenWeatherMap API key.
.It Fl i Ar value
Toggle UV Index display (
.Ar true
or
.Ar false
).
.It Fl w Ar value
Toggle wind data display (
.Ar true
or
.Ar false
).
.It Fl h Ar value
Toggle humidity data display (
.Ar true
or
.Ar false
).
.It Fl H Ar value
Toggle Feels like display (
.Ar true
or
.Ar false
).
.It Fl p Ar value
Toggle pressure data display (
.Ar true
or
.Ar false
).
.It Fl d Ar value
Toggle daylight data display (
.Ar true
or
.Ar false
).
.It Fl v
Display version.
.El
.Sh EXAMPLES
Display forecast using metric units for the next five days (showing
symbols and daylight data) for Rzeszow, Poland:
.Pp
ansiweather -l "Rzeszow,PL" -u metric -s true -f 5 -d true
.Sh AUTHORS
.Nm
was written by
.An Frederic Cambus .