wttr/src/http/help.zig
2026-01-06 17:00:34 -08:00

135 lines
5.6 KiB
Zig
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

const std = @import("std");
pub const help_page =
\\wttr - Weather Forecast Service
\\
\\Based on wttr.in. items below with an * are not implemented in this version
\\
\\Usage:
\\
\\ $ curl <base url> # current location
\\ $ curl <base url>/muc # weather in the Munich airport
\\
\\Supported location types:
\\
\\ /paris # city name
\\ /~Eiffel+tower # any location (+ for spaces)
\\ /Москва # Unicode name of any location in any language
\\ /muc # airport code (3 letters)
\\ /@stackoverflow.com # domain name
\\ /94107 # area codes
\\ /-78.46,106.79 # GPS coordinates
\\
\\Moon phase information (not yet implemented):
\\
\\ /moon # Moon phase (add ,+US or ,+France for these cities)
\\ /moon@2016-10-25 # Moon phase for the date (@2016-10-25)
\\
\\Query string units:
\\
\\ m # metric (SI) (used by default everywhere except US)
\\ u # USCS (used by default in US)
\\ M # * show wind speed in m/s
\\
\\Query string view options:
\\
\\ 0 # only current weather
\\ 1 # current weather + today's forecast
\\ 2 # current weather + today's + tomorrow's forecast
\\ A # ignore User-Agent and force ANSI output format (terminal)
\\ d # * restrict output to standard console font glyphs
\\ F # do not show the "Follow" line (not necessary - this version does not have a follow line)
\\ n # narrow version (only day and night)
\\ q # quiet version (no "Weather report" text)
\\ Q # superquiet version (no "Weather report", no city name)
\\ T # switch terminal sequences off (no colors)
\\
\\Output formats:
\\
\\ format=1 # one-line: "London: ⛅️ +7°C"
\\ format=2 # one-line with wind: "London: ⛅️ +7°C 🌬↗11km/h"
\\ format=3 # one-line detailed: "London: ⛅️ +7°C 🌬↗11km/h 💧65%"
\\ format=4 # one-line full: "London: ⛅️ +7°C 🌬↗11km/h 💧65% ☀06:45-16:32"
\\ format=j1 # JSON output
\\ format=v2 # * data-rich experimental format
\\ format=p1 # * Prometheus metrics format
\\ format=%l:+%c+%t # custom format (see format codes below)
\\
\\Custom format codes:
\\
\\ %c # weather condition emoji
\\ %C # weather condition text
\\ %h # humidity
\\ %t # temperature (actual)
\\ %f # temperature (feels like)
\\ %w # wind
\\ %l # location
\\ %m # * moon phase emoji
\\ %M # * moon day
\\ %p # precipitation (mm)
\\ %o # probability of precipitation
\\ %P # pressure (hPa)
\\ %D # * dawn time
\\ %S # * sunrise time
\\ %z # * zenith time
\\ %s # * sunset time
\\ %d # * dusk time
\\
\\PNG options:
\\
\\ /paris.png # generate a PNG file
\\ p # add frame around the output
\\ t # transparency 150
\\ transparency=... # transparency from 0 to 255 (255 = not transparent)
\\ background=... # background color in form RRGGBB, e.g. 00aaaa
\\
\\Options can be combined:
\\
\\ /Paris?0pq
\\ /Paris?0pq&lang=fr
\\ /Paris_0pq.png # in PNG the file mode are specified after _
\\ /Rome_0pq_lang=it.png # long options are separated with underscore
\\
\\* Localization:
\\
\\ $ curl fr.wttr.in/Paris
\\ $ curl wttr.in/paris?lang=fr
\\ $ curl -H "Accept-Language: fr" wttr.in/paris
\\
\\* Supported languages:
\\
\\ am ar af be bn ca da de el et fr fa gl hi hu ia id it lt mg nb nl oc pl pt-br ro ru ta tr th uk vi zh-cn zh-tw (supported)
\\ az bg bs cy cs eo es eu fi ga hi hr hy is ja jv ka kk ko ky lv mk ml mr nl fy nn pt pt-br sk sl sr sr-lat sv sw te uz zh zu he (in progress)
\\
\\Special URLs:
\\
\\ /:help # show this page
\\ /:bash.function # show recommended bash function wttr()
\\ /:translation # show the information about the translators
;
pub const translation_page =
\\wttr Translation
\\
\\wttr is currently translated into 54 languages.
\\
\\NOTE: Translations are not implemented in this version!
\\
\\Language Support:
\\ - Automatic detection via Accept-Language header
\\ - Manual selection via ?lang=CODE parameter
\\ - Subdomain selection (e.g., de.wttr.in)
\\
\\Contributing:
\\ To help translate wttr.in, visit:
\\ https://github.com/chubin/wttr.in
\\
;
test "help page exists" {
try std.testing.expect(help_page.len > 0);
}
test "translation page exists" {
try std.testing.expect(translation_page.len > 0);
}