make UI tips context-dependent
[cycon.git] / cycon.1
blob4ae95bcc56078dd6b2b371726d004ed1fb34b68d
1 .Dd 2019-02-21
2 .Dt CYCON 1
3 .Os
4 .Sh NAME
5 .Nm cycon
6 .Nd Connect to Cytube
7 .Sh SYNOPSIS
8 .Nm
9 .Oo
10 .Fl s
11 .Ar server
12 .Oc
13 .Oo
14 .Fl h
15 .Oc
16 .Fl c
17 .Ar channel
18 .Sh DESCRIPTION
19 .Nm
20 gives a TUI for viewing a cytube channel.
21 .Sh OPTIONS
22 .Bl -tag -width Ds
23 .It Fl s
24 Use
25 .Ar server
26 instead of the default
27 .Pq Ar cytu.be .
28 The value is used when fetching
29 .Dl \&
30 .Dl http[s]:// Ns Ar server Ns /socketconfig/ Ns Ar channel Ns .json
31 .Dl http[s]:// Ns Ar server Ns /socket.io
32 .Dl \&
33 .It Fl h
34 Use http instead of https when connecting to
35 .Ar server .
36 .It Fl c
37 Specify the
38 .Ar channel
39 to connect to.
40 .El
41 .Sh CONTROLS
42 .Nm
43 displays two panes. The bottom pane contains a playlist. This
44 playlist is refreshed every few minutes, although simple changes
45 such as adding entries or switching files are handled immediately.
46 .Pp
47 The top pane contanes either the chat or the URL of the media which
48 is selected in the bottom pane.
49 .Pp
50 At any given moment, the keys you can press are
51 .Bl -tag -width Ds
52 .It C
53 Set the top pane to show the chat.
54 .It U
55 Set the top pane to show the URI of whatever entry is selected in
56 the playlist.
57 .It K/Up arrow
58 Scroll up in the playlist.
59 .It J/down arrow
60 Scroll down in the playlist.
61 .It V
62 Run
63 .Dl \&
64 .Dl mpv-with-load-screen --quiet Ar URI
65 .Dl \&
66 where
67 .Ar URI
68 is given by the currently selected entry in the playlist. No
69 time-syncing is performed
70 .Po
71 you can do that yourself by examining the timer at the bottom of
72 the playlist
73 .Pc .
74 The player does not automatically track playlist changes. Some media
75 types may cause mpv to hang. You may have to write the
76 .Pa mpv-with-load-screen
77 script yourself.
78 .It D
79 Run
80 .Dl \&
81 .Dl youtube-dl --quiet --no-warnings Ar URI
82 .Dl \&
83 where
84 .Ar URI
85 is given by the currently selected entry in the playlist. No output
86 is displayed, so it's up to you to know when the download is complete.
87 .It Q
88 Quit.
89 .El
90 .Sh BUGS
91 Not many errors are correctly reported to the user. For example, if
92 .Ev DISPLAY
93 is unset in the environment, or if
94 .Pa mpv-with-load-screen
95 is not in
96 .Ev PATH ,
97 .Sq V
98 will probably do nothing, silently.
99 .Sh AUTHORS
100 .An De Rais Aq Mt derais@cock.li