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