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