another pass over the documentation
This commit is contained in:
parent
03de0675a5
commit
e1fc3405c6
|
@ -23,13 +23,13 @@
|
|||
The honk filtering and censorship system,
|
||||
.Nm hfcs ,
|
||||
controls what messages are seen and how they are presented to the user.
|
||||
Filter rules are based on series of matches and actions.
|
||||
Filter rules are based on a series of matches and actions.
|
||||
It is accessed via the
|
||||
.Pa filters
|
||||
menu item.
|
||||
.Pp
|
||||
The following match types are possible.
|
||||
All criteria must match.
|
||||
All nonempty criteria must match.
|
||||
.Bl -tag -width include-audience
|
||||
.It Ar who
|
||||
Match an actor or domain name.
|
||||
|
@ -47,6 +47,8 @@ Regular expression match against the post
|
|||
.Fa content .
|
||||
.It Ar is announce
|
||||
Is announced (shared).
|
||||
.It Ar announce of
|
||||
Limit prevous match to only specified actor or domain name.
|
||||
.El
|
||||
.Pp
|
||||
The following actions may be applied.
|
||||
|
@ -75,6 +77,9 @@ Specifically, an argument
|
|||
.Ql re
|
||||
will be automatically rewritten as
|
||||
.Ql \\\b(?i:re)\\\b .
|
||||
The
|
||||
.Ar replace
|
||||
text may refer to submatches using $1, etc.
|
||||
.Pp
|
||||
An optional expiration may be specified as a duration.
|
||||
XdYhZm for X days, Y hours, and Z minutes.
|
||||
|
|
16
docs/honk.1
16
docs/honk.1
|
@ -66,9 +66,11 @@ via other means will appear in the relevant combos.
|
|||
.Pp
|
||||
In addition to honkers, it is possible to subscribe to a hashtag collection.
|
||||
(Where supported.)
|
||||
Enter the collection URL as the honker URL.
|
||||
Enter the collection URL for
|
||||
.Ar url .
|
||||
.Pp
|
||||
Separately, hashtags may be added to a combo by creating a honker with a url
|
||||
Separately, hashtags may be added to a combo by creating a honker with a
|
||||
.Ar url
|
||||
of the desired hashtag (including #).
|
||||
.Ss Viewing
|
||||
The primary feed is accessed via the
|
||||
|
@ -112,7 +114,9 @@ but this is unreliable.
|
|||
Acknowledge reading this post.
|
||||
Typically if it's a reply to one's own post.
|
||||
.It Ic save
|
||||
Save this honk to make it easy to find later.
|
||||
Save this honk to the
|
||||
.Pa saved
|
||||
tab to find later.
|
||||
.It Ic untag me
|
||||
Sometimes a thread goes on entirely too long.
|
||||
Untag will hide further replies to the selected post, but without muting the
|
||||
|
@ -151,12 +155,14 @@ can be of great use to restore order to one's timeline.
|
|||
Accessed via the
|
||||
.Pa filters
|
||||
menu item.
|
||||
.Ss xzone
|
||||
.Ss Xzone
|
||||
The
|
||||
.Pa xzone
|
||||
page lists recently seen honkers that are not otherwise tracked.
|
||||
It also allows the import of external objects via URL, either individual
|
||||
posts or actor URLs, in which case their recent outbox is imported.
|
||||
.Ss Account
|
||||
It's all about you.
|
||||
.Sh ENVIRONMENT
|
||||
.Nm
|
||||
is designed to work with most browsers, but for optimal results it is
|
||||
|
@ -188,4 +194,4 @@ The ActivityPub standard is subject to interpretation, and not all
|
|||
implementations are as enlightened as
|
||||
.Nm .
|
||||
.Sh BUGS
|
||||
Only features.
|
||||
It's a feature.
|
||||
|
|
|
@ -28,6 +28,8 @@ The process begins by pressing the button marked
|
|||
.Dq it's honking time
|
||||
to activate the honk form.
|
||||
.Pp
|
||||
Honks are posted publicly.
|
||||
.Pp
|
||||
A subset of markdown is supported.
|
||||
.Bl -tag -width tenletters
|
||||
.It bold
|
||||
|
@ -76,7 +78,7 @@ Threads from the tiny bird site may be included as quotes in a post via the
|
|||
operator followed by the URL.
|
||||
.Dl hoot: https://twitter.com/tedunangst/status/850379741492367360
|
||||
.Pp
|
||||
Custom emoji may included by colon wrapping the image name.
|
||||
Custom emoji may be included by colon wrapping the image name.
|
||||
.Pq :hellsyeah:
|
||||
A meme (sticker, reaction gif) may be included with the
|
||||
.Ar meme
|
||||
|
|
|
@ -112,6 +112,8 @@ The database may grow large over time.
|
|||
The
|
||||
.Ic cleanup
|
||||
command exists to purge old data, by default 30 days.
|
||||
This removes unreferenced, unsaved posts and attachments.
|
||||
It does not remove any original content.
|
||||
.Ss UPGRADE
|
||||
Stop the old honk process.
|
||||
.Dl pkill honk
|
||||
|
|
|
@ -22,5 +22,5 @@
|
|||
.Sh DESCRIPTION
|
||||
The vital improvements module,
|
||||
.Nm ,
|
||||
is used to customize and extend honk's behavior in such rare cases as the
|
||||
is used to customize and extend honk in such rare cases as the
|
||||
existing functionality proves insufficient.
|
||||
|
|
Loading…
Reference in New Issue