diff options
| author | Hiltjo Posthuma <hiltjo@codemadness.org> | 2017-04-27 13:13:04 +0200 |
|---|---|---|
| committer | Hiltjo Posthuma <hiltjo@codemadness.org> | 2017-04-27 13:13:04 +0200 |
| commit | 1b71671a2d71c3ea8e39d4603eb8f21043d1f975 (patch) | |
| tree | a7d453df0608aef06083d276d84866fd8144d90a /sfeed.1 | |
| parent | 379541c1eb276b5527a0c79093c5c8925628a2e1 (diff) | |
man pages: fix a few warnings and improve a few words
- fix new warning check (start sentence at each line).
- improve a few words.
Diffstat (limited to 'sfeed.1')
| -rw-r--r-- | sfeed.1 | 25 |
1 files changed, 14 insertions, 11 deletions
@@ -9,21 +9,24 @@ .Op Ar baseurl .Sh DESCRIPTION .Nm -reads RSS or Atom feed data (XML) from stdin. It writes the feed data in a -TAB-separated format to stdout. A +reads RSS or Atom feed data (XML) from stdin. +It writes the feed data in a TAB-separated format to stdout. +A .Ar baseurl -can be specified if the links in the feed are relative urls. It is -recommended to always have absolute urls in your feeds. +can be specified if the links in the feed are relative urls. +It is recommended to always have absolute urls in your feeds. .Sh TAB-SEPARATED FORMAT FIELDS The items are saved in a TSV-like 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. Control -characters are removed. +whitespace characters are replaced by a single space character. +Control characters are removed. .Pp -The content field can contain newlines and is escaped. TABs, newlines and '\\' -are escaped with '\\', so it becomes: '\\t', '\\n' and '\\\\'. Other whitespace -characters except space are removed. Control characters are removed. +The content field can contain newlines and is escaped. +TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n' +and '\\\\'. +Other whitespace characters except spaces are removed. +Control characters are removed. .Pp The order and content of the fields are: .Bl -tag -width 17n @@ -34,8 +37,8 @@ Title text, HTML code in titles is ignored and is treated as plain-text. .It link Absolute url, unsafe characters are encoded. .It content -Content, can have plain-text or HTML code depending on the content\-type field. -.It content\-type +Content, can have plain-text or HTML code depending on the content-type field. +.It content-type "html" or "plain". .It id RSS item GUID or Atom id. |