all repos — honk @ 16bff20071bfa42a5ac15edce71a9a4e94248520

my fork of honk

docs/honk.1 (view raw)

  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 status updates and other microblog activities.
 26This is the user manual.
 27For administration, see
 28.Xr honk 8 .
 29.Pp
 30This manual is still incomplete.
 31It'll get there eventually.
 32.Ss Following
 33In order to receive regular updates from other users, one must first follow them.
 34Begin at the
 35.Pa honkers
 36tab.
 37The
 38.Ar url
 39field is required.
 40Either of two forms are accepted, the user's handle (or webfinger) or their
 41ActivityPub actor URL.
 42The
 43.Ar name
 44field is optional and will be automatically inferred.
 45Examples:
 46.Dl @user@example.social
 47.Dl https://example.social/users/user
 48.Pp
 49.Pp
 50After following a fellow honker, they may be added to one or more
 51.Ic combos .
 52These are accessed via the
 53.Pa combos
 54tab and allow easy access to particular groupings.
 55The special combo name of one hyphen
 56.Sq -
 57will remove a honker's posts from the primary feed.
 58.Ss Viewing
 59The primary feed is accessed via the home tab.
 60It will contain posts from all followed honkers.
 61Posts mentioning the user, both followed and not, are collected under the
 62.Pa @me
 63tab.
 64.Pp
 65Individual honks contain a visual representation of the honker's ID,
 66their name, the activity (with a link back to origin), a link to the
 67parent post if applicable, and the convoy (thread) identifier.
 68Screenshot below.
 69.Pp
 70.Lk screenshot-honk.png screenshot of one honk
 71.Pp
 72Available actions are:
 73.Bl -tag -width tenletters
 74.It Ic bonk
 75Share with followers.
 76Not available for nonpublic honks.
 77.It Ic honk back
 78Reply.
 79.It Ic mute
 80Mute this entire thread.
 81Existing posts are hidden, and future posts will not appear in any feed.
 82.It Ic zonk
 83Delete this post.
 84When deleting one's own post, other servers will be requested to remove it,
 85but this is unreliable.
 86.It Ic ack
 87Acknowledge reading this post.
 88Typically if it's a reply to one's own post.
 89.It Ic edit
 90Change it up.
 91Alas, Update activities do not federate reliably.
 92.El
 93.Ss Honking
 94Refer to the
 95.Xr honk 5
 96section of the manual.
 97.Ss HFCS
 98Sometimes other users of the federation can get unruly.
 99The honk filtering and censorship system,
100.Xr hfcs 1,
101can be of great use to restore order to one's timeline.
102.Sh SEE ALSO
103.Xr intro 1 ,
104.Xr honk 8
105.Sh STANDARDS
106.Pp
107.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
108.Pp
109.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
110.Sh HISTORY
111Started March 2019.
112.Sh AUTHORS
113Ted Unangst.
114.Sh CAVEATS
115The ActivityPub standard is subject to interpretation, and not all
116implementations are as enlightened as
117.Nm .
118.Sh BUGS
119Only features.