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
 31Honks are posted publicly.
 32.Ss Basics
 33A subset of markdown is supported.
 34.Bl -tag -width tenletters
 35.It bold
 36**bold text**
 37.It italics
 38*italicized text*
 39.It quotes
 40> This text is quoted.
 41.It code
 42Inline `code fragments` with single ticks.
 43.Bd -literal
 44```c
 45/* triple tick code blocks support syntax highlighting */
 46int main() { return 0; }
 47```
 48.Ed
 49.It headings
 50Heading lines starting with #.
 51.It lists
 52Lists of items starting with either
 53.Sq +
 54or
 55.Sq - .
 56.It tables
 57Table cells separated by |.
 58.It images
 59Inline images with img tags.
 60.Bd -literal
 61<img alt="Lifecycle of a honk" src="https://example.com/diagram.png">
 62.Ed
 63.It links
 64URLs beginning with
 65.Dq http
 66or
 67.Dq https
 68will be autolinked.
 69.It rules
 70Exactly three dashes on a line,
 71.Dq --- ,
 72will become a horizontal rule.
 73.El
 74.Pp
 75If the first line of a honk begins with
 76.Dq DZ:
 77(danger zone) it will be used a summary and the post marked sensitive. 
 78.Pp
 79Mentioning a specfic user such as
 80.Pq @user@example.social
 81will send a copy of the message to them.
 82Several forms are supported.
 83.Ql @name
 84will work using the short name from the
 85.Pa honkers
 86table and be expanded automatically.
 87.Ql @handle@domain
 88will work for anyone.
 89.Ql @https://example.com
 90works as well.
 91When honking back, the author of the parent post is automatically mentioned.
 92.Ss Extras
 93Threads from the tiny bird site may be included as quotes in a post via the
 94.Ar hoot
 95operator followed by the URL.
 96.Dl hoot: https://twitter.com/tedunangst/status/850379741492367360
 97.Pp
 98Custom emoji may be included by colon wrapping the image name.
 99.Pq :hellsyeah:
100A meme (sticker, reaction gif) may be included with the
101.Ar meme
102operator followed by the file name.
103.Dl meme: honk.mp4
104A full list of emoji and memes may be found in the
105.Pa funzone .
106.Pp
107Custom flag emoji may be generated on the fly by specifying comma separated
108hexadecimal RGB values, one for each stripe.
109.Dl flag:306,002,dcf
110Vertical stripes may be selected by specfying "vert" for the first value.
111.Pp
112There are no length restrictions, but remember, somebody is going to have
113to read this noise.
114.Pp
115One may attach a file to a post.
116Images are automatically rescaled and reduced in size for federation.
117A description, or caption, is encouraged.
118Text files and PDFs are also supported as attachments.
119Other formats are not supported.
120.Pp
121One may also check in to a location.
122The available fields, all optional, are
123.Ar name ,
124.Ar url ,
125.Ar latitude ,
126and
127.Ar longitude .
128By default, location data is rounded to approximately 1/100 decimal degree
129accuracy.
130Pressing the check in button a second time will refine this to more a
131precise location.
132.Pp
133Adding a time to a post turns it into an event.
134Supported formats for start time are HH:MM or YYYY-MM-DD HH:MM.
135A 24 hour clock is assumed, unless am or pm are specified.
136The duration is optional and may be specified as XdYhZm for X days, Y hours,
137and Z minutes (1d12h would be a 36 hour event).
138.Pp
139When everything is at last ready to go, press the
140.Dq it's gonna be honked
141button.
142.Sh EXAMPLES
143(Slightly dated screenshots.)
144.Pp
145Composing a new honk with an attached image and location.
146.Pp
147.Lk screenshot-compose.png screenshot of honk composition
148.Pp
149After posting.
150.Pp
151.Lk screenshot-afterpost.jpg screenshot of honk after posting
152.Sh SEE ALSO
153.Xr honk 1
154.Sh CAVEATS
155Markdown support is implemented with regexes.
156Preview is recommended.