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