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 5
 18.Os
 19.Sh NAME
 20.Nm honk
 21.Nd status composition
 22.Sh DESCRIPTION
 23Status updates composed in
 24.Nm
 25have many features beyond just plain text.
 26.Pp
 27The process begins by pressing the button marked
 28.Dq it's honking time
 29to activate the honk form.
 30.Pp
 31A subset of markdown is supported.
 32.Bl -tag -width tenletters
 33.It bold
 34**bold text**
 35.It italics
 36*italicized text*
 37.It quotes
 38> This text is quoted.
 39.It code
 40Inline `code fragments` with single ticks.
 41.Bd -literal
 42```c
 43/* triple tick code blocks support syntax highlighting */
 44int main() { return 0; }
 45```
 46.Ed
 47.It links
 48URLs beginning with
 49.Dq http
 50or
 51.Dq https
 52will be autolinked.
 53.El
 54.Pp
 55Mentioning a specfic user such as
 56.Pq @user@example.social
 57will send a copy of the message to them.
 58Several forms are supported.
 59.Ql @name
 60will work using the short name from the
 61.Pa honkers
 62table and be expanded automatically.
 63.Ql @handle@domain
 64will work for anyone.
 65.Ql @https://example.com
 66works as well.
 67When honking back, the author of the parent post is automatically mentioned.
 68.Pp
 69Threads from the tiny bird site may be included as quotes in a post via the
 70.Ar hoot
 71operator followed by the URL.
 72.Dl hoot: https://twitter.com/tedunangst/status/835172824734175234
 73.Pp
 74Custom emoji may included by colon wrapping the image name.
 75.Pq :hellsyeah:
 76A meme (sticker, reaction gif) may be included with the
 77.Ar meme
 78operator followed by the file name.
 79.Dl meme: honk.mp4
 80A full list of emoji and memes may be found in the
 81.Pa funzone .
 82.Pp
 83There are no length restrictions, but remember, somebody is going to have
 84to read this noise.
 85.Pp
 86One may attach a file to a post.
 87Images are automatically rescaled and reduced in size for federation.
 88A description, or caption, is encouraged.
 89Text files are also supported as attachments.
 90Other formats are not supported.
 91.Pp
 92One may also check in to a location.
 93The available fields, all optional, are
 94.Ar name ,
 95.Ar url ,
 96.Ar latitude ,
 97and
 98.Ar longitude .
 99By default, location data is rounded to approximately 1/100 decimal degree
100accuracy.
101Pressing the check in button a second time will refine this to more a
102precise location.
103.Pp
104When everything is at last ready to go, press the
105.Dq it's gonna be honked
106button.
107.Sh SEE ALSO
108.Xr honk 1
109.Sh CAVEATS
110Markdown support is implemented with regexes.
111Preview is recommended.