diff options
| author |  Chloe Kudryavtsev <toast@toast.cafe> | 2019-11-23 20:14:06 -0500 |
|---|---|---|
| committer | Chloe Kudryavtsev <toast@toast.cafe> | 2019-11-23 20:14:06 -0500 |
| commit | 1302e523038eb127742d7f2dc4f88d0f73f10f0e (patch) | |
| tree | 1e707a9f2302dda0a490788ccefb90f7f1480503 /doc | |
| parent | Remove changelog: everything changed. (diff) | |
Update docs to rewrite
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/brpaste.adoc | 26 |
1 files changed, 10 insertions, 16 deletions
diff --git a/doc/brpaste.adoc b/doc/brpaste.adoc index 226b7f6..eddb605 100644 --- a/doc/brpaste.adoc +++ b/doc/brpaste.adoc @@ -1,6 +1,6 @@ = brpaste(1) Chloe Kudryavtsev -v0.0.1a +v2.0.0 :doctype: manpage == Name @@ -13,11 +13,9 @@ brpaste - a pastebin service that's so fast, it burns rubber. == Options -*-b, --bind*=_BIND_ADDRESS_:: - Bind to address _BIND_ADDRESS_. May be used multiple times. -*-p, --port*=_LISTEN_PORT_:: - Listen on port _LISTEN_PORT_. -*-r, --redis*=_REDIS_URI_:: +*--bind*=_BIND_ADDRESS_:: + Bind to address _BIND_ADDRESS_. +*--redis*=_REDIS_URI_:: Connect to Redis using _REDIS_URI_. == Endpoints @@ -28,11 +26,15 @@ _GET_ */*:: Provides examples. Includes submission form. -_GET_ */:id?(syntax|lang=syntax)*:: +_GET_ */:id*:: User-facing viewer of paste _id_. + Standard view. + +_GET_ */:id/:syntax*:: + Same as */:id*. If javascript is available, attempt to highlight the paste as _syntax_. -_GET_ */raw/:id*:: +_GET_ */:id/raw*:: Raw contents of paste _id_. Mime is set to plaintext. @@ -44,11 +46,3 @@ _POST_ */* _data_=*content*:: _PUT_ */:id* _data_=*content*:: Put *content* into _id_. If _id_ already exists, abort. - -_GET|REPORT_ */health*:: - Returns 204 is healthy. - Gives more information in case of failure. - -== See Also - -https://vibed.org/ |