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 react
130Please no.
131.It Ic edit
132Change it up.
133Alas, Update activities do not federate reliably.
134.Ss Refresh
135Clicking the refresh button will load new honks, if any.
136New honks will be subtly highlighted.
137.El
138.Ss Honking
139Refer to the
140.Xr honk 5
141section of the manual for details of honk composition.
142.Ss Search
143Find old honks.
144It's basic substring match with a few extensions.
145The following keywords are supported:
146.Bl -tag -width honker
147.It site
148Substring match on the post domain name.
149.It honker
150Exact match, either AP actor or honker nickname.
151.It -
152Negate term.
153.El
154.Pp
155Example:
156.Dl honker:goose big moose -footloose
157This query will find honks by the goose about the big moose, but excluding
158those about footloose.
159.Ss Filtering
160Sometimes other users of the federation can get unruly.
161The honk filtering and censorship system,
162.Xr hfcs 1 ,
163can be of great use to restore order to one's timeline.
164Accessed via the
165.Pa filters
166menu item.
167.Ss Xzone
168The
169.Pa xzone
170page lists recently seen honkers that are not otherwise tracked.
171It also allows the import of external objects via URL, either individual
172posts or actor URLs, in which case their recent outbox is imported.
173.Ss Account
174It's all about you.
175An avatar may be selected from the
176.Pa funzone
177by adding
178.Dq avatar: filename.png
179to one's profile info.
180If truly necessary.
181.Pp
182Some options to customize the site appearance:
183.Bl -tag -width skinny
184.It skinny
185Use a narrower column for the main display.
186.It omit images
187Omit img tags, to lighten page loads on slow connections.
188.It apple
189Prefer Apple links for maps.
190The default is OpenStreetMap.
191.It reaction
192Pick an emoji for reacting to posts.
193.El
194.Sh ENVIRONMENT
195.Nm
196is designed to work with most browsers, but for optimal results it is
197recommended to use a
1982015 or later Thinkpad X1 Carbon with 2560x1440 screen running
199.Ox
200and chromium at 150% scaling with the dwm window manager.
201This will enable the main menu to line up just right.
202.Sh SEE ALSO
203.Xr intro 1 ,
204.Xr honk 8
205.Sh STANDARDS
206.Pp
207.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
208.Pp
209.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
210.Sh HISTORY
211Started March 2019.
212.Sh AUTHORS
213.An Ted Unangst Lk https://honk.tedunangst.com/u/tedu @tedu@honk.tedunangst.com
214.Sh CAVEATS
215Completing some operations, such as subscribing to new honkers, requires an
216aptitude for clipboard use and tab switching along with a steady hand.
217For the most part, these are infrequent operations, but they are also the
218first operations new users encounter.
219This is not ideal.
220.Pp
221The ActivityPub standard is subject to interpretation, and not all
222implementations are as enlightened as
223.Nm .
224.Sh BUGS
225It's a feature.