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