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.
 92Screenshot below.
 93.Pp
 94.Lk screenshot-honk.png screenshot of one honk
 95.Pp
 96Available actions are:
 97.Bl -tag -width tenletters
 98.It Ic bonk
 99Share with followers.
100Not available for nonpublic honks.
101.It Ic honk back
102Reply.
103.It Ic mute
104Mute this entire thread.
105Existing posts are hidden, and future posts will not appear in any feed.
106.It Ic zonk
107Delete this post.
108When deleting one's own post, other servers will be requested to remove it,
109but this is unreliable.
110.It Ic ack
111Acknowledge reading this post.
112Typically if it's a reply to one's own post.
113.It Ic save
114Save this honk to make it easy to find later.
115.It Ic untag
116Sometimes a thread goes on entirely too long.
117Untag will hide further replies to the selected post, but without muting the
118entire thread.
119Replies higher in the tree are still received.
120.It Ic edit
121Change it up.
122Alas, Update activities do not federate reliably.
123.El
124.Ss Honking
125Refer to the
126.Xr honk 5
127section of the manual for details of honk composition.
128.Ss Search
129Find old honks.
130It's basic substring match with a few extensions.
131The following keywords are supported:
132.Bl -tag -width honker
133.It site
134Substring match on the post domain name.
135.It honker
136Exact match, either AP actor or honker nickname.
137.El
138.Pp
139Example:
140.Dl honker:goose big moose
141This query will find honks by the goose about the big moose.
142.Ss Filtering
143Sometimes other users of the federation can get unruly.
144The honk filtering and censorship system,
145.Xr hfcs 1 ,
146can be of great use to restore order to one's timeline.
147Accessed via the
148.Pa filters
149menu item.
150.Ss xzone
151The
152.Pa xzone
153page lists recently seen honkers that are not otherwise tracked.
154It also allows the import of external objects via URL, either individual
155posts or actor URLs, in which case their recent outbox is imported.
156.Sh ENVIRONMENT
157.Nm
158is designed to work with most browsers, but for optimal results it is
159recommended to use a
1602015 or later Thinkpad X1 Carbon with 2560x1440 screen running
161.Ox
162and chromium at 150% scaling with the dwm window manager.
163This will enable the main menu to line up just right.
164.Sh SEE ALSO
165.Xr intro 1 ,
166.Xr honk 8
167.Sh STANDARDS
168.Pp
169.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
170.Pp
171.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
172.Sh HISTORY
173Started March 2019.
174.Sh AUTHORS
175.An Ted Unangst Lk https://honk.tedunangst.com/u/tedu @tedu@honk.tedunangst.com
176.Sh CAVEATS
177The ActivityPub standard is subject to interpretation, and not all
178implementations are as enlightened as
179.Nm .
180.Sh BUGS
181Only features.