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