docs/honk.1 (view raw)
1.\"
2.\" Copyright (c) 2019 Ted Unangst
3.\"
4.\" Permission to use, copy, modify, and distribute this software for any
5.\" purpose with or without fee is hereby granted, provided that the above
6.\" copyright notice and this permission notice appear in all copies.
7.\"
8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd $Mdocdate$
17.Dt HONK 1
18.Os
19.Sh NAME
20.Nm honk
21.Nd federated status conveyance
22.Sh DESCRIPTION
23The
24.Nm
25utility processes federated status updates and other microblog activities.
26This is the user manual.
27For administration, see
28.Xr honk 8 .
29.Pp
30This manual is still incomplete.
31It'll get there eventually.
32.Ss Honkers
33In order to receive regular updates from other users, they must first
34be added to one's honker collection.
35Begin at the
36.Pa honkers
37tab.
38The
39.Ar url
40field is required.
41Either of two forms are accepted, the user's handle (or webfinger) or their
42ActivityPub actor URL.
43The
44.Ar name
45field is optional and will be automatically inferred.
46Examples:
47.Dl @user@example.social
48.Dl https://example.social/users/user
49.Pp
50.Pp
51Fellow honkers may be added to one or more
52.Ic combos
53to suit one's organizational preferences.
54These are accessed via the
55.Pa combos
56tab and allow easy access to particular groupings.
57The special combo name of one hyphen
58.Sq -
59will remove a honker's posts from the primary feed.
60.Ss Viewing
61The primary feed is accessed via the home tab.
62It will contain posts from nearly all honkers.
63Posts mentioning the user, both followed and not, are collected under the
64.Pa @me
65tab.
66.Pp
67Individual honks contain a visual representation of the honker's ID,
68their name, the activity (with a link back to origin), a link to the
69parent post if applicable, and the convoy (thread) identifier.
70Screenshot below.
71.Pp
72.Lk screenshot-honk.png screenshot of one honk
73.Pp
74Available actions are:
75.Bl -tag -width tenletters
76.It Ic bonk
77Share with followers.
78Not available for nonpublic honks.
79.It Ic honk back
80Reply.
81.It Ic mute
82Mute this entire thread.
83Existing posts are hidden, and future posts will not appear in any feed.
84.It Ic zonk
85Delete this post.
86When deleting one's own post, other servers will be requested to remove it,
87but this is unreliable.
88.It Ic ack
89Acknowledge reading this post.
90Typically if it's a reply to one's own post.
91.It Ic save
92Save this honk to make it easy to find later.
93.It Ic edit
94Change it up.
95Alas, Update activities do not federate reliably.
96.El
97.Ss Honking
98Refer to the
99.Xr honk 5
100section of the manual for details of honk composition.
101.Ss HFCS
102Sometimes other users of the federation can get unruly.
103The honk filtering and censorship system,
104.Xr hfcs 1 ,
105can be of great use to restore order to one's timeline.
106.Sh ENVIRONMENT
107.Nm
108is designed to work with most browsers, but for optimal results it is
109recommended to use a
1102015 or later Thinkpad X1 Carbon with 2560x1440 screen running
111.Ox
112and chromium at 150% scaling with the dwm window manager.
113This will enable the main menu to line up just right.
114.Sh SEE ALSO
115.Xr intro 1 ,
116.Xr honk 8
117.Sh STANDARDS
118.Pp
119.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
120.Pp
121.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
122.Sh HISTORY
123Started March 2019.
124.Sh AUTHORS
125.An Ted Unangst Lk @tedu@honk.tedunangst.com https://honk.tedunangst.com/u/tedu
126.Sh CAVEATS
127The ActivityPub standard is subject to interpretation, and not all
128implementations are as enlightened as
129.Nm .
130.Sh BUGS
131Only features.