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 SYNOPSIS
 23.Nm honk
 24.Sh DESCRIPTION
 25The
 26.Nm
 27utility processes status updates and other microblog activities.
 28This is the user manual.
 29For administration, see
 30.Xr honk 8 .
 31.Pp
 32This manual is very incomplete.
 33Refer to the text files.
 34.Ss Following
 35In order to receive posts from other users, one must follow them.
 36Begin at the
 37.Pa honkers
 38tab.
 39The
 40.Ar url
 41field is required.
 42Either of two forms are accepted, the user's handle (or webfinger) or their
 43ActivityPub actor URL.
 44The
 45.Ar name
 46field is optional and will be automatically inferred.
 47Examples:
 48.Dl @user@example.social
 49.Dl https://example.social/users/user
 50.Pp
 51.Pp
 52After following a fellow honker, they may be added to one or more
 53.Ic combos .
 54These are accessed via the
 55.Pa combos
 56tab and allow easy access to particular groupings.
 57The special combo name of one hyphen
 58.Sq -
 59will remove a honker's posts from the primary feed.
 60.Ss Viewing
 61The primary feed is accessed via the home tab, labelled
 62.Pa honk .
 63It will contain posts from all followed honkers.
 64Posts mentioning the user, both followed and not, are collected under the
 65.Pa @me
 66tab.
 67.Pp
 68.Lk screenshot-honk.png screen of one honk
 69.Ss Honking
 70On the home page and most other pages, there will be a button marked
 71.Dq it's honking time
 72which activates the honk form.
 73.Pp
 74The in reply to field is an advanced feature.
 75.Pp
 76One may attach a file to a post.
 77Images are automatically rescaled and reduced in size for federation.
 78.Pp
 79A limited subset of markdown is supported.
 80Bold, italics, and code blocks.
 81Mentioning a specfic user
 82.Pq @user@example.social
 83will send a copy of the message to them.
 84When replying, the author of the parent post is automatically mentioned.
 85.Ss zonkzone
 86Sometimes other users of the federation can get unruly.
 87The zonkzone can be of great use to restore order to one's timeline.
 88.Sh SEE ALSO
 89.Xr honk 8
 90.Sh STANDARDS
 91.Pp
 92.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
 93.Pp
 94.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
 95.Sh HISTORY
 96Started March 2019.
 97.Sh AUTHORS
 98Ted Unangst.
 99.Sh CAVEATS
100Not all ActivityPub implementations work the same way.
101.Sh BUGS
102Only features.