x_x.rst 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. .. RST source for x_x(1) man page. Convert with:
  2. .. rst2man.py x_x.rst > x_x.1
  3. .. rst2man.py comes from the SBo development/docutils package.
  4. .. |version| replace:: 20150330_d236f8f
  5. .. |date| date::
  6. .. converting from pod:
  7. .. s/B<\([^>]*\)>/**\1**/g
  8. .. s/I<\([^>]*\)>/*\1*/g
  9. ===
  10. x_x
  11. ===
  12. -----------------------------------------
  13. display Excel and CSV files on a terminal
  14. -----------------------------------------
  15. :Manual section: 1
  16. :Manual group: SlackBuilds.org
  17. :Date: |date|
  18. :Version: |version|
  19. SYNOPSIS
  20. ========
  21. x_x [**-h** *row*] [**-f** *csv|excel*] [**-d** *delimiter*] [**-q** *quotechar*] [**-e** *encoding*]
  22. DESCRIPTION
  23. ===========
  24. x_x (the Dead Guy CLI) is a command line reader that displays either
  25. Excel files or CSVs in your terminal. The purpose of this is to not
  26. break the workflow of people who live on the command line and need to
  27. access a spreadsheet generated using Microsoft Excel.
  28. OPTIONS
  29. =======
  30. **-h**, **--heading** *row*
  31. Row number containing the headings (default: none). Note: the first row is
  32. numbered 0, not 1!
  33. **-f**, **--file-type** *csv|excel*
  34. Override autodetection of input file type.
  35. **-d**, **--delimiter** *character*
  36. Delimiter (only applicable to CSV files) [default: ','].
  37. **-q**, **--quotechar**
  38. Quote character (only applicable to CSV files) [default: '"'].
  39. **-e**, **--encoding** *encoding*
  40. Encoding [default: UTF-8].
  41. **--version**
  42. Show the version and exit.
  43. **--help**
  44. Show built-in help and exit.
  45. EXAMPLES
  46. ========
  47. So, for example:
  48. ::
  49. $ x_x dead_guys.xlsx
  50. +---------------+--------------+
  51. | A | B |
  52. +---------------+--------------+
  53. | Person | Age at Death |
  54. | Harrold Holt | 59.0 |
  55. | Harry Houdini | 52.0 |
  56. | Howard Hughes | 70.0 |
  57. Or to specify a specific row as the header which will be visible on each page:
  58. ::
  59. $ x_x -h 0 dead_guys.xlsx
  60. +---------------+--------------+
  61. | Person | Age at Death |
  62. +---------------+--------------+
  63. | Harrold Holt | 59.0 |
  64. | Harry Houdini | 52.0 |
  65. | Howard Hughes | 70.0 |
  66. Weird CSVs? No problem!
  67. ::
  68. $ cat dead_guys.csv
  69. person;age_at_death
  70. Harrold Holt;59
  71. Harry Houdini;52
  72. Howard Hughes;70
  73. |Not some guy, but just a string with ; in it|;0
  74. ::
  75. $ x_x -h 0 --delimiter=';' --quotechar='|' dead_guys.csv
  76. +----------------------------------------------+--------------+
  77. | person | age_at_death |
  78. +----------------------------------------------+--------------+
  79. | Harrold Holt | 59 |
  80. | Harry Houdini | 52 |
  81. | Howard Hughes | 70 |
  82. | Not some guy, but just a string with ; in it | 0 |
  83. Does your CSV file not end in "csv"? Again, no problem:
  84. ::
  85. $ mv dead_guys.csv dead_guys.some_other_extension
  86. $ x_x -h 0 --file-type=csv --delimiter=';' --quotechar='|' dead_guys.some_other_extension
  87. +----------------------------------------------+--------------+
  88. | person | age_at_death |
  89. +----------------------------------------------+--------------+
  90. | Harrold Holt | 59 |
  91. | Harry Houdini | 52 |
  92. | Howard Hughes | 70 |
  93. | Not some guy, but just a string with ; in it | 0 |
  94. COPYRIGHT
  95. =========
  96. See the file /usr/doc/x_x-|version|/LICENSE for license information.
  97. AUTHORS
  98. =======
  99. x_x was written by krockode.
  100. This man page written for the SlackBuilds.org project
  101. by B. Watson, and is licensed under the WTFPL.
  102. SEE ALSO
  103. ========
  104. The x_x homepage: https://github.com/krockode/x_x