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.
 46The
 47.Ar name
 48field is optional and will be automatically inferred.
 49Examples:
 50.Dl @user@example.social
 51.Dl https://example.social/users/user
 52.Pp
 53Fellow honkers may be added to one or more
 54.Ic combos
 55to suit one's organizational preferences.
 56These are accessed via the
 57.Pa combos
 58tab and allow easy access to particular groupings.
 59The special combo name of one hyphen
 60.Sq -
 61will exclude a honker's posts from the primary feed.
 62.Pp
 63It is also possible to skip subscribing.
 64In this case, regular posts are not received, but replies and posts fetched
 65via other means will appear in the relevant combos.
 66.Pp
 67In addition to honkers, it is possible to subscribe to a hashtag collection.
 68(Where supported.)
 69Enter the collection URL as the honker URL.
 70.Pp
 71Separately, hashtags may be added to a combo by creating a honker with a url
 72of the desired hashtag (including #).
 73.Ss Viewing
 74The primary feed is accessed via the
 75.Pa home
 76tab.
 77It will contain posts from all honkers except those specifically excluded.
 78Posts mentioning the user, both followed and not, are collected under the
 79.Pa @me
 80tab.
 81Other feeds include
 82.Pa first
 83which excludes replies, the user defined options under the
 84.Pa combos
 85subheading, and the
 86.Pa events
 87page which lists only events.
 88.Pp
 89Individual honks contain a visual representation of the honker's ID,
 90their name, the activity (with a link back to origin), a link to the
 91parent post if applicable, and the convoy (thread) identifier.
 92A red border indicates the honk is not public.
 93Screenshot below.
 94.Pp
 95.Lk screenshot-honk.png screenshot of one honk
 96.Pp
 97Available actions are:
 98.Bl -tag -width tenletters
 99.It Ic bonk
100Share with followers.
101Not available for nonpublic honks.
102.It Ic honk back
103Reply.
104.It Ic mute
105Mute this entire thread.
106Existing posts are hidden, and future posts will not appear in any feed.
107.It Ic zonk
108Delete this post.
109When deleting one's own post, other servers will be requested to remove it,
110but this is unreliable.
111.It Ic ack
112Acknowledge reading this post.
113Typically if it's a reply to one's own post.
114.It Ic save
115Save this honk to make it easy to find later.
116.It Ic untag me
117Sometimes a thread goes on entirely too long.
118Untag will hide further replies to the selected post, but without muting the
119entire thread.
120Replies higher in the tree are still received.
121.It Ic edit
122Change it up.
123Alas, Update activities do not federate reliably.
124.Ss Refresh
125Clicking the refresh button will load new honks, if any.
126New honks will be subtly highlighted.
127.El
128.Ss Honking
129Refer to the
130.Xr honk 5
131section of the manual for details of honk composition.
132.Ss Search
133Find old honks.
134It's basic substring match with a few extensions.
135The following keywords are supported:
136.Bl -tag -width honker
137.It site
138Substring match on the post domain name.
139.It honker
140Exact match, either AP actor or honker nickname.
141.El
142.Pp
143Example:
144.Dl honker:goose big moose
145This query will find honks by the goose about the big moose.
146.Ss Filtering
147Sometimes other users of the federation can get unruly.
148The honk filtering and censorship system,
149.Xr hfcs 1 ,
150can be of great use to restore order to one's timeline.
151Accessed via the
152.Pa filters
153menu item.
154.Ss xzone
155The
156.Pa xzone
157page lists recently seen honkers that are not otherwise tracked.
158It also allows the import of external objects via URL, either individual
159posts or actor URLs, in which case their recent outbox is imported.
160.Sh ENVIRONMENT
161.Nm
162is designed to work with most browsers, but for optimal results it is
163recommended to use a
1642015 or later Thinkpad X1 Carbon with 2560x1440 screen running
165.Ox
166and chromium at 150% scaling with the dwm window manager.
167This will enable the main menu to line up just right.
168.Sh SEE ALSO
169.Xr intro 1 ,
170.Xr honk 8
171.Sh STANDARDS
172.Pp
173.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
174.Pp
175.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
176.Sh HISTORY
177Started March 2019.
178.Sh AUTHORS
179.An Ted Unangst Lk https://honk.tedunangst.com/u/tedu @tedu@honk.tedunangst.com
180.Sh CAVEATS
181Completing some operations, such as subscribing to new honkers, requires an
182aptitude for clipboard use and tab switching along with a steady hand.
183For the most part, these are infrequent operations, but they are also the
184first operations new users encounter.
185This is not ideal.
186.Pp
187The ActivityPub standard is subject to interpretation, and not all
188implementations are as enlightened as
189.Nm .
190.Sh BUGS
191Only features.