x_x.1 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. .\" Man page generated from reStructuredText.
  2. .
  3. .TH X_X 1 "2020-11-15" "20150330_d236f8f" "SlackBuilds.org"
  4. .SH NAME
  5. x_x \- display Excel and CSV files on a terminal
  6. .
  7. .nr rst2man-indent-level 0
  8. .
  9. .de1 rstReportMargin
  10. \\$1 \\n[an-margin]
  11. level \\n[rst2man-indent-level]
  12. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13. -
  14. \\n[rst2man-indent0]
  15. \\n[rst2man-indent1]
  16. \\n[rst2man-indent2]
  17. ..
  18. .de1 INDENT
  19. .\" .rstReportMargin pre:
  20. . RS \\$1
  21. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22. . nr rst2man-indent-level +1
  23. .\" .rstReportMargin post:
  24. ..
  25. .de UNINDENT
  26. . RE
  27. .\" indent \\n[an-margin]
  28. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29. .nr rst2man-indent-level -1
  30. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32. ..
  33. .\" RST source for x_x(1) man page. Convert with:
  34. .
  35. .\" rst2man.py x_x.rst > x_x.1
  36. .
  37. .\" rst2man.py comes from the SBo development/docutils package.
  38. .
  39. .\" converting from pod:
  40. .
  41. .\" s/B<\([^>]*\)>/**\1**/g
  42. .
  43. .\" s/I<\([^>]*\)>/*\1*/g
  44. .
  45. .SH SYNOPSIS
  46. .sp
  47. x_x [\fB\-h\fP \fIrow\fP] [\fB\-f\fP \fIcsv|excel\fP] [\fB\-d\fP \fIdelimiter\fP] [\fB\-q\fP \fIquotechar\fP] [\fB\-e\fP \fIencoding\fP]
  48. .SH DESCRIPTION
  49. .sp
  50. x_x (the Dead Guy CLI) is a command line reader that displays either
  51. Excel files or CSVs in your terminal. The purpose of this is to not
  52. break the workflow of people who live on the command line and need to
  53. access a spreadsheet generated using Microsoft Excel.
  54. .SH OPTIONS
  55. .INDENT 0.0
  56. .TP
  57. .B \fB\-h\fP, \fB\-\-heading\fP \fIrow\fP
  58. Row number containing the headings (default: none). Note: the first row is
  59. numbered 0, not 1!
  60. .TP
  61. .B \fB\-f\fP, \fB\-\-file\-type\fP \fIcsv|excel\fP
  62. Override autodetection of input file type.
  63. .TP
  64. .B \fB\-d\fP, \fB\-\-delimiter\fP \fIcharacter\fP
  65. Delimiter (only applicable to CSV files) [default: \(aq,\(aq].
  66. .TP
  67. .B \fB\-q\fP, \fB\-\-quotechar\fP
  68. Quote character (only applicable to CSV files) [default: \(aq"\(aq].
  69. .TP
  70. .B \fB\-e\fP, \fB\-\-encoding\fP \fIencoding\fP
  71. Encoding [default: UTF\-8].
  72. .TP
  73. .B \fB\-\-version\fP
  74. Show the version and exit.
  75. .TP
  76. .B \fB\-\-help\fP
  77. Show built\-in help and exit.
  78. .UNINDENT
  79. .SH EXAMPLES
  80. .sp
  81. So, for example:
  82. .INDENT 0.0
  83. .INDENT 3.5
  84. .sp
  85. .nf
  86. .ft C
  87. $ x_x dead_guys.xlsx
  88. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  89. | A | B |
  90. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  91. | Person | Age at Death |
  92. | Harrold Holt | 59.0 |
  93. | Harry Houdini | 52.0 |
  94. | Howard Hughes | 70.0 |
  95. .ft P
  96. .fi
  97. .UNINDENT
  98. .UNINDENT
  99. .sp
  100. Or to specify a specific row as the header which will be visible on each page:
  101. .INDENT 0.0
  102. .INDENT 3.5
  103. .sp
  104. .nf
  105. .ft C
  106. $ x_x \-h 0 dead_guys.xlsx
  107. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  108. | Person | Age at Death |
  109. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  110. | Harrold Holt | 59.0 |
  111. | Harry Houdini | 52.0 |
  112. | Howard Hughes | 70.0 |
  113. .ft P
  114. .fi
  115. .UNINDENT
  116. .UNINDENT
  117. .sp
  118. Weird CSVs? No problem!
  119. .INDENT 0.0
  120. .INDENT 3.5
  121. .sp
  122. .nf
  123. .ft C
  124. $ cat dead_guys.csv
  125. person;age_at_death
  126. Harrold Holt;59
  127. Harry Houdini;52
  128. Howard Hughes;70
  129. |Not some guy, but just a string with ; in it|;0
  130. .ft P
  131. .fi
  132. .UNINDENT
  133. .UNINDENT
  134. .INDENT 0.0
  135. .INDENT 3.5
  136. .sp
  137. .nf
  138. .ft C
  139. $ x_x \-h 0 \-\-delimiter=\(aq;\(aq \-\-quotechar=\(aq|\(aq dead_guys.csv
  140. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  141. | person | age_at_death |
  142. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  143. | Harrold Holt | 59 |
  144. | Harry Houdini | 52 |
  145. | Howard Hughes | 70 |
  146. | Not some guy, but just a string with ; in it | 0 |
  147. .ft P
  148. .fi
  149. .UNINDENT
  150. .UNINDENT
  151. .sp
  152. Does your CSV file not end in "csv"? Again, no problem:
  153. .INDENT 0.0
  154. .INDENT 3.5
  155. .sp
  156. .nf
  157. .ft C
  158. $ mv dead_guys.csv dead_guys.some_other_extension
  159. $ x_x \-h 0 \-\-file\-type=csv \-\-delimiter=\(aq;\(aq \-\-quotechar=\(aq|\(aq dead_guys.some_other_extension
  160. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  161. | person | age_at_death |
  162. +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
  163. | Harrold Holt | 59 |
  164. | Harry Houdini | 52 |
  165. | Howard Hughes | 70 |
  166. | Not some guy, but just a string with ; in it | 0 |
  167. .ft P
  168. .fi
  169. .UNINDENT
  170. .UNINDENT
  171. .SH COPYRIGHT
  172. .sp
  173. See the file /usr/doc/x_x\-20150330_d236f8f/LICENSE for license information.
  174. .SH AUTHORS
  175. .sp
  176. x_x was written by krockode.
  177. .sp
  178. This man page written for the SlackBuilds.org project
  179. by B. Watson, and is licensed under the WTFPL.
  180. .SH SEE ALSO
  181. .sp
  182. The x_x homepage: \fI\%https://github.com/krockode/x_x\fP
  183. .\" Generated by docutils manpage writer.
  184. .