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 images
 48Inline images with img tags.
 49.Bd -literal
 50<img alt="Lifecycle of a honk" src="https://example.com/diagram.png">
 51.Ed
 52.It links
 53URLs beginning with
 54.Dq http
 55or
 56.Dq https
 57will be autolinked.
 58.El
 59.Pp
 60Mentioning a specfic user such as
 61.Pq @user@example.social
 62will send a copy of the message to them.
 63Several forms are supported.
 64.Ql @name
 65will work using the short name from the
 66.Pa honkers
 67table and be expanded automatically.
 68.Ql @handle@domain
 69will work for anyone.
 70.Ql @https://example.com
 71works as well.
 72When honking back, the author of the parent post is automatically mentioned.
 73.Pp
 74Threads from the tiny bird site may be included as quotes in a post via the
 75.Ar hoot
 76operator followed by the URL.
 77.Dl hoot: https://twitter.com/tedunangst/status/850379741492367360
 78.Pp
 79Custom emoji may included by colon wrapping the image name.
 80.Pq :hellsyeah:
 81A meme (sticker, reaction gif) may be included with the
 82.Ar meme
 83operator followed by the file name.
 84.Dl meme: honk.mp4
 85A full list of emoji and memes may be found in the
 86.Pa funzone .
 87.Pp
 88There are no length restrictions, but remember, somebody is going to have
 89to read this noise.
 90.Pp
 91One may attach a file to a post.
 92Images are automatically rescaled and reduced in size for federation.
 93A description, or caption, is encouraged.
 94Text files and PDFs are also supported as attachments.
 95Other formats are not supported.
 96.Pp
 97One may also check in to a location.
 98The available fields, all optional, are
 99.Ar name ,
100.Ar url ,
101.Ar latitude ,
102and
103.Ar longitude .
104By default, location data is rounded to approximately 1/100 decimal degree
105accuracy.
106Pressing the check in button a second time will refine this to more a
107precise location.
108.Pp
109Adding a time to a post turns it into an event.
110Supported formats for start time are HH:MM or YYYY-MM-DD HH:MM.
111A 24 hour clock is assumed, unless am or pm are specified.
112The duration is optional and may be specified as XdYhZm for X days, Y hours,
113and Z minutes (1d12h would be a 36 hour event).
114.Pp
115When everything is at last ready to go, press the
116.Dq it's gonna be honked
117button.
118.Sh SEE ALSO
119.Xr honk 1
120.Sh CAVEATS
121Markdown support is implemented with regexes.
122Preview is recommended.