1 .\" Copyright (c) 2023 Omar Polo <op@omarpolo.com>
2 .\"
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
6 .\"
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .\"
15 .Dd December 10, 2023
16 .Dt AMUSED-WEB 1
17 .Os
18 .Sh NAME
19 .Nm amused-web
20 .Nd web interface for the amused music player
21 .Sh SYNOPSIS
22 .Nm
23 .Op Fl v
24 .Op Fl s Ar socket
25 .Op Oo Ar host Oc Ar port
26 .Sh DESCRIPTION
27 .Nm
28 is a web interface to control the
29 .Xr amused 1
30 music player.
31 It exposes a web server that listen on
32 .Ar host
33 at the given
34 .Ar port .
35 By default all IPv4 and IPv6 address at port 9090.
36 .Pp
37 The following options are available:
38 .Bl -tag -width tenletters
39 .It Fl s Ar socket
40 Path to the
41 .Xr amused 1
42 control socket.
43 By default
44 .Pa /tmp/amused-UID
45 is used.
46 .It Fl v
47 Produce more verbose output.
48 .El
49 .Sh ENVIRONMENT
50 .Bl -tag -width tenletters
51 .It Ev TEMPDIR
52 Path to the directory where the control socket looked for.
53 Defaults to
54 .Pa /tmp .
55 .El
56 .Sh SEE ALSO
57 .Xr amused 1
58 .Sh AUTHORS
59 .An -nosplit
60 The
61 .Nm
62 program was written by
63 .An Omar Polo Aq Mt op@omarpolo.com .
64 .Sh CAVEATS
65 .Nm
66 should be hosted only in trusted networks because it doesn't employ all
67 the techniques that would be needed to prevent abuses in public
68 networks.
69 If reachable in a public network, it should at least be protected by a
70 password.
71 .Pp
72 Depending on the browser and the address from where
73 .Nm
74 is accessed, the use of TLS may be required.