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