dirk
/
honk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

some more messing around with the manual

This commit is contained in:
Ted Unangst 2019-10-09 17:11:25 -04:00
parent 04c65dcc0f
commit 8587e9ceb9
5 changed files with 49 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/activitypub.7
View File

@ -49,7 +49,7 @@ Supported.
Appears similar to a Note.
Can be both created and received, but
.Vt Invite
ativities are ignored.
activities are ignored.
.It Vt Video
Limited support.
.It Vt Audio
@ -93,6 +93,7 @@ and
.Vt Undo
require that the original request be quoted, not referred to by URI.
.It Vt Update
Supported.
Honk sends and receives
.Vt Update
activities.
@ -108,6 +109,7 @@ or
.Fa attachment .
.Bl -tag -width tenletters
.It Mention
Pretty @ machine.
.It Emoji
Inline text :emoji: with image replacement.
.It Place
@ -127,6 +129,7 @@ and
.Fa longitude .
.It Document
Plain text and images in jpeg, gif, png, and webp formats are supported.
Other formats are linked to origin.
.El
.Ss SECURITY
Honk uses http signatures.
@ -135,10 +138,16 @@ Honk implements the
.Vt webfinger
end point and will use it for @mention resolution.
It is not required for federation.
.Ss LD-JSON
Not really.
.Sh SEE ALSO
.Xr intro 1 ,
.Xr honk 1
.Sh STANDARDS
.Pp
.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
.Pp
.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
.Sh CAVEATS
The ActivityPub standard is subject to interpretation, and not all
implementations are as enlightened as honk.

12
docs/honk.1
View File

@ -22,7 +22,7 @@
.Sh DESCRIPTION
The
.Nm
utility processes status updates and other microblog activities.
utility processes federated status updates and other microblog activities.
This is the user manual.
For administration, see
.Xr honk 8 .
@ -99,6 +99,14 @@ Sometimes other users of the federation can get unruly.
The honk filtering and censorship system,
.Xr hfcs 1 ,
can be of great use to restore order to one's timeline.
.Sh ENVIRONMENT
.Nm
is designed to work with most browsers, but for optimal results it is
recommended to use a
2015 or later Thinkpad X1 Carbon with 2560x1440 screen running
.Ox
and chromium at 150% scaling with the dwm window manager.
This will enable the main menu to line up just right.
.Sh SEE ALSO
.Xr intro 1 ,
.Xr honk 8
@ -110,7 +118,7 @@ can be of great use to restore order to one's timeline.
.Sh HISTORY
Started March 2019.
.Sh AUTHORS
Ted Unangst.
.An Ted Unangst Lk @tedu@honk.tedunangst.com https://honk.tedunangst.com/u/tedu
.Sh CAVEATS
The ActivityPub standard is subject to interpretation, and not all
implementations are as enlightened as

30
docs/honk.5
View File

@ -55,6 +55,15 @@ will be autolinked.
Mentioning a specfic user such as
.Pq @user@example.social
will send a copy of the message to them.
Several forms are supported.
.Ql @name
will work using the short name from the
.Pa honkers
table and be expanded automatically.
.Ql @handle@domain
will work for anyone.
.Ql @https://example.com
works as well.
When honking back, the author of the parent post is automatically mentioned.
.Pp
Threads from the tiny bird site may be included as quotes in a post via the
@ -95,23 +104,8 @@ precise location.
When everything is at last ready to go, press the
.Dq it's gonna be honked
button.
.Ss zonkzone
Sometimes other users of the federation can get unruly.
The zonkzone can be of great use to restore order to one's timeline.
.Sh SEE ALSO
.Xr honk 8
.Sh STANDARDS
.Pp
.Lk https://www.w3.org/TR/activitypub/ "ActivityPub"
.Pp
.Lk https://www.w3.org/TR/activitystreams-vocabulary/ "Activity Vocabulary"
.Sh HISTORY
Started March 2019.
.Sh AUTHORS
Ted Unangst.
.Xr honk 1
.Sh CAVEATS
The ActivityPub standard is subject to interpretation, and not all
implementations are as enlightened as
.Nm .
.Sh BUGS
Only features.
Markdown support is implemented with regexes.
Preview is recommended.

17
docs/honk.8
View File

@ -38,7 +38,9 @@ Make sure to pass the Host header, if necessary (as for nginx).
proxy_set_header Host $http_host;
.Ed
.Ss INIT
Run the init command.
Run the
.Ic init
command.
.Dl ./honk init
This will create the database and ask four questions, as well as creating
the initial user.
@ -54,18 +56,25 @@ Run honk.
Log messages are sent to stderr and should probably be redirected to a file.
.Ss MAINTENANCE
The database may grow large over time.
The cleanup command exists to purge old data, by default 30 days.
The
.Ic cleanup
command exists to purge old data, by default 30 days.
.Ss UPGRADE
Stop the old honk process.
.Dl pkill honk
Backup the database.
.Dl cp honk.db backup.db
Upgrade.
Perform the upgrade with the
.Ic upgrade
command.
.Dl ./honk upgrade
Restart.
.Dl ./honk
.\" .Sh EXAMPLES
.Sh ENVIRONMENT
Image processing and scaling requires considerable memory.
It is recommended to adjust the datasize ulimit to at least 1GB.
.Sh SEE ALSO
.Xr intro 1 ,
.Xr honk 1
.Sh CAVEATS
There's no online upgrade capability.

10
docs/intro.1
View File

@ -20,16 +20,14 @@
.Nm intro
.Nd introduction to honk documentation
.Sh DESCRIPTION
The
.Nm
utility processes status updates and other microblog activities.
This is the index.
Honk processes federated status updates and other microblog activities.
This is the index for the honk manual.
.Pp
.Bl -tag -width activitypubxxr
.It Xr honk 1
User manual.
.It Xr hfcs 1
Honk Filtering and Censorship System.
Honk Filtering and Censorsing System.
.It Xr honk 5
Honk composition.
.It Xr activitypub 7
@ -40,4 +38,4 @@ Administration manual.
.Sh HISTORY
Started March 2019.
.Sh AUTHORS
Ted Unangst.
.An Ted Unangst Lk @tedu@honk.tedunangst.com https://honk.tedunangst.com/u/tedu