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