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 .
 29For other documentation, refer to the
 30.Xr intro 1 .
 31.Pp
 32This manual is still incomplete.
 33It'll get there eventually.
 34.Ss Honkers
 35Initially, there won't be much to see after logging in.
 36In order to receive regular updates from other users, they must first
 37be added to one's honker collection.
 38Begin at the
 39.Pa honkers
 40tab.
 41The
 42.Ar url
 43field is required.
 44Either of two forms are accepted, the user's handle (or webfinger) or their
 45ActivityPub actor URL.
 46.Pp
 47.Dl @user@example.social
 48.Dl https://example.social/users/user
 49.Pp
 50The
 51.Ar name
 52field is optional and will be automatically inferred.
 53The
 54.Ar notes
 55field is reserved for user remarks.
 56Fellow honkers may be added to one or more
 57.Ar combos
 58to suit one's organizational preferences.
 59These are accessed via the
 60.Pa combos
 61tab and allow easy access to particular groupings.
 62The special combo name of one hyphen
 63.Sq -
 64will exclude a honker's posts from the primary feed.
 65.Pp
 66It is also possible to skip subscribing.
 67In this case, regular posts are not received, but replies and posts fetched
 68via other means will appear in the relevant combos.
 69.Pp
 70In addition to honkers, it is possible to subscribe to a hashtag collection.
 71(Where supported.)
 72Enter the collection URL for
 73.Ar url .
 74.Pp
 75Separately, hashtags may be added to a combo by creating a honker with a
 76.Ar url
 77of the desired hashtag (including #).
 78Several hashtags may thus be collected in a single combo.
 79.Ss Viewing
 80The primary feed is accessed via the
 81.Pa home
 82tab.
 83It will contain posts from all honkers except those specifically excluded.
 84Posts mentioning the user, both followed and not, are collected under the
 85.Pa @me
 86tab.
 87Other feeds include
 88.Pa first
 89which excludes replies, the user defined options under the
 90.Pa combos
 91subheading, and the
 92.Pa events
 93page which lists only events.
 94.Pp
 95Individual honks contain a visual representation of the honker's ID,
 96their name, the activity (with a link back to origin), a link to the
 97parent post if applicable, and the convoy (thread) identifier.
 98A red border indicates the honk is not public.
 99Screenshot below.
100.Pp
101.Lk screenshot-honk.png screenshot of one honk
102.Pp
103Available actions are:
104.Bl -tag -width tenletters
105.It Ic bonk
106Share with followers.
107Not available for nonpublic honks.
108.It Ic honk back
109Reply.
110.It Ic mute
111Mute this entire thread.
112Existing posts are hidden, and future posts will not appear in any feed.
113.It Ic zonk
114Delete this post.
115When deleting one's own post, other servers will be requested to remove it,
116but this is unreliable.
117.It Ic ack
118Acknowledge reading this post.
119Typically if it's a reply to one's own post.
120.It Ic save
121Save this honk to the
122.Pa saved
123tab to find later.
124.It Ic untag me
125Sometimes a thread goes on entirely too long.
126Untag will hide further replies to the selected post, but without muting the
127entire thread.
128Replies higher in the tree are still received.
129.It Ic badonk
130Please no.
131.It Ic edit
132Change it up.
133.Ss Refresh
134Clicking the refresh button will load new honks, if any.
135New honks will be subtly highlighted.
136.El
137.Ss Hotkeys
138The following keyboard shortcuts may also be used to navigate.
139.Bl -tag -width short
140.It j
141Scroll to next honk.
142.It k
143Scroll to previous honk.
144.It r
145Refresh.
146.It s
147Scroll down to oldest newest.
148.It m
149Open menu.
150.It esc
151Close menu.
152.It /
153Search.
154.El
155.Ss Honking
156Refer to the
157.Xr honk 5
158section of the manual for details of honk composition.
159.Ss Search
160Find old honks.
161It's basic substring match with a few extensions.
162The following keywords are supported:
163.Bl -tag -width honker:
164.It @me
165Honks mentioning the user.
166.It @self
167Honks by the user.
168.It before:
169Honks posted before YYYY-MM-DD.
170.It after:
171As above.
172.It site:
173Substring match on the post domain name.
174.It honker:
175Exact match, either AP actor or honker nickname.
176.It -
177Negate term.
178.El
179.Pp
180Example:
181.Dl honker:goose big moose -footloose
182This query will find honks by the goose about the big moose, but excluding
183those about footloose.
184.Ss Filtering
185Sometimes other users of the federation can get unruly.
186The honk filtering and censorship system,
187.Xr hfcs 1 ,
188can be of great use to restore order to one's timeline.
189Accessed via the
190.Pa filters
191menu item.
192.Ss Xzone
193The
194.Pa xzone
195page lists recently seen honkers that are not otherwise tracked.
196It also allows the import of external objects via URL, either individual
197posts or actor URLs, in which case their recent outbox is imported.
198Probably easier to use the search box for this.
199.Ss Account
200It's all about you.
201An avatar may be selected from the
202.Pa funzone
203meme collection by adding
204.Dq avatar: filename.png
205to one's profile info.
206If truly necessary.
207A banner may be set by specifying
208.Dq banner: image.jpg .
209See
210.Xr honk 8
211for more about the funzone.
212.Pp
213Some options to customize the site appearance:
214.Bl -tag -width skinny
215.It skinny
216Use a narrower column for the main display.
217.It omit images
218Omit img tags, to lighten page loads on slow connections.
219.It apple
220Prefer Apple links for maps.
221The default is OpenStreetMap.
222.It reaction
223Pick an emoji for reacting to posts.
224.El
225.Sh ENVIRONMENT
226.Nm
227is designed to work with most browsers, but for optimal results it is
228recommended to use a
2292015 or later Thinkpad X1 Carbon with 2560x1440 screen running
230.Ox
231and chromium at 150% scaling with the dwm window manager.
232This will enable the main menu to line up just right.
233.Sh SEE ALSO
234.Xr intro 1 ,
235.Xr honk 8
236.Sh STANDARDS
237.Pp
238.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
239.Pp
240.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
241.Sh HISTORY
242Started March 2019.
243.Sh AUTHORS
244.An Ted Unangst Lk https://honk.tedunangst.com/u/tedu @tedu@honk.tedunangst.com
245.Sh CAVEATS
246Completing some operations, such as subscribing to new honkers, requires an
247aptitude for clipboard use and tab switching along with a steady hand.
248For the most part, these are infrequent operations, but they are also the
249first operations new users encounter.
250This is not ideal.
251.Pp
252The ActivityPub standard is subject to interpretation, and not all
253implementations are as enlightened as
254.Nm .
255.Sh BUGS
256It's a feature.