sfeed.5 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .Dd January 7, 2023
  2. .Dt SFEED 5
  3. .Os
  4. .Sh NAME
  5. .Nm sfeed
  6. .Nd feed format
  7. .Sh SYNOPSIS
  8. .Nm
  9. .Sh DESCRIPTION
  10. .Xr sfeed 1
  11. writes the feed data in a TAB-separated format to stdout.
  12. .Sh TAB-SEPARATED FORMAT FIELDS
  13. The items are output per line in a TAB-separated format.
  14. .Pp
  15. For the fields title, id and author each whitespace character is replaced by a
  16. SPACE character.
  17. Control characters are removed.
  18. .Pp
  19. The content field can contain newlines and these are escaped.
  20. TABs, newlines and '\e' are escaped with '\e', so it becomes: '\et', '\en'
  21. and '\e\e'.
  22. Other whitespace characters except spaces are removed.
  23. Control characters are removed.
  24. .Pp
  25. The order and content of the fields are:
  26. .Bl -tag -width 15n
  27. .It 1. timestamp
  28. UNIX timestamp in UTC+0, empty if missing or on a parse failure.
  29. .It 2. title
  30. Title text, HTML code in titles is ignored and is treated as plain-text.
  31. .It 3. link
  32. Link
  33. .It 4. content
  34. Content, can have plain-text or HTML code depending on the content-type field.
  35. .It 5. content-type
  36. "html" or "plain" if it has content.
  37. .It 6. id
  38. RSS item GUID or Atom id.
  39. .It 7. author
  40. Item, first author.
  41. .It 8. enclosure
  42. Item, first enclosure.
  43. .It 9. category
  44. Item, categories, multiple values are separated by the '|' character.
  45. .El
  46. .Sh SEE ALSO
  47. .Xr sfeed 1 ,
  48. .Xr sfeed_plain 1
  49. .Sh AUTHORS
  50. .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org