diff options
| author | Hiltjo Posthuma <hiltjo@codemadness.org> | 2021-07-27 11:25:02 +0200 |
|---|---|---|
| committer | Hiltjo Posthuma <hiltjo@codemadness.org> | 2021-08-03 20:43:54 +0200 |
| commit | 702fd5193030cae25c199e7c4dba7a9be1ba89cc (patch) | |
| tree | 0d14b58d285b15724b3d5a643b4425d4f2b51f25 /sfeed.5 | |
| parent | 7199cd10a97e9d648b594cf6327f9ed7fa732527 (diff) | |
man page improvements
Diffstat (limited to 'sfeed.5')
| -rw-r--r-- | sfeed.5 | 16 |
1 files changed, 7 insertions, 9 deletions
@@ -1,4 +1,4 @@ -.Dd July 6, 2021 +.Dd July 29, 2021 .Dt SFEED 5 .Os .Sh NAME @@ -10,13 +10,13 @@ .Xr sfeed 1 writes the feed data in a TAB-separated format to stdout. .Sh TAB-SEPARATED FORMAT FIELDS -The items are output per line in a TSV-like format. +The items are output per line in a TAB-separated format. .Pp -The fields: title, id, author are not allowed to have newlines and TABs, all -whitespace characters are replaced by a single space character. +For the fields title, id and author each whitespace character is replaced by a +SPACE character. Control characters are removed. .Pp -The content field can contain newlines and is escaped. +The content field can contain newlines and these are escaped. TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n' and '\\\\'. Other whitespace characters except spaces are removed. @@ -49,7 +49,5 @@ Item, categories, multiple values are separated by |. .Sh AUTHORS .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org .Sh CAVEATS -If a timezone is not in the RFC-822 or RFC-3339 format it is not supported and -the UNIX timestamp is interpreted as UTC+0. -.Pp -HTML in titles is treated as plain-text. +If a timezone for the timestamp field is not in the RFC822 or RFC3339 format it +is not supported and the timezone is interpreted as UTC+0. |