File: csvformat.1

package info (click to toggle)
csvkit 2.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 40,664 kB
  • sloc: python: 4,924; perl: 1,000; makefile: 131; sql: 4
file content (141 lines) | stat: -rw-r--r-- 4,172 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CSVFORMAT" "1" "Aug 16, 2024" "2.2.0" "csvkit"
.SH NAME
csvformat \- csvformat Documentation
.SH DESCRIPTION
.sp
Convert a CSV file to a custom output format.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: csvformat [\-h] [\-d DELIMITER] [\-t] [\-q QUOTECHAR] [\-u {0,1,2,3}] [\-b]
                 [\-p ESCAPECHAR] [\-z FIELD_SIZE_LIMIT] [\-e ENCODING]
                 [\-L LOCALE] [\-S] [\-H] [\-K SKIP_LINES] [\-v] [\-l] [\-\-zero] [\-V]
                 [\-E] [\-D OUT_DELIMITER] [\-T] [\-A] [\-Q OUT_QUOTECHAR]
                 [\-U {0,1,2,3}] [\-B] [\-P OUT_ESCAPECHAR]
                 [\-M OUT_LINETERMINATOR]
                 [FILE]

Convert a CSV file to a custom output format.

positional arguments:
  FILE                  The CSV file to operate on. If omitted, will accept
                        input as piped data via STDIN.

optional arguments:
  \-h, \-\-help            show this help message and exit
  \-E, \-\-skip\-header     Do not output a header row.
  \-D OUT_DELIMITER, \-\-out\-delimiter OUT_DELIMITER
                        Delimiting character of the output file.
  \-T, \-\-out\-tabs        Specify that the output file is delimited with tabs.
                        Overrides \(dq\-D\(dq.
  \-A, \-\-out\-asv         Specify that the output file is delimited with the
                        ASCII unit separator and record separator. Overrides
                        \(dq\-T\(dq, \(dq\-D\(dq and \(dq\-M\(dq.
  \-Q OUT_QUOTECHAR, \-\-out\-quotechar OUT_QUOTECHAR
                        Character used to quote strings in the output file.
  \-U {0,1,2,3}, \-\-out\-quoting {0,1,2,3}
                        Quoting style used in the output file: 0 quote
                        minimal, 1 quote all, 2 quote non\-numeric, 3 quote
                        none.
  \-B, \-\-out\-no\-doublequote
                        Whether or not double quotes are doubled in the output
                        file.
  \-P OUT_ESCAPECHAR, \-\-out\-escapechar OUT_ESCAPECHAR
                        Character used to escape the delimiter in the output
                        file if \-\-quoting 3 (\(dqQuote None\(dq) is specified and to
                        escape the QUOTECHAR if \-\-out\-no\-doublequote is
                        specified.
  \-M OUT_LINETERMINATOR, \-\-out\-lineterminator OUT_LINETERMINATOR
                        Character used to terminate lines in the output file.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See also: \fI\%Arguments common to all tools\fP\&.
.SH EXAMPLES
.sp
Convert a comma\-separated file to a pipe\-delimited file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
csvformat \-D \(dq|\(dq examples/dummy.csv
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Convert to carriage return line\-endings:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
csvformat \-M $\(aq\er\(aq examples/dummy.csv
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Convert to a tab\-delimited file (TSV) with no doubling of double quotes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
printf \(aqkey,value\en1,\(dqa \(dq\(dqquoted\(dq\(dq string\(dq\(aq | csvformat \-T \-Q🐍
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To avoid escaping quote characters when using \fB\-\-quoting 3\fP, add \fB\-\-out\-quotechar \(dq\(dq\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
csvformat \-u3 \-U3 \-Q🐍 examples/optional_quote_characters.csv
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Christopher Groskopf and contributors
.SH COPYRIGHT
2016, Christopher Groskopf and James McKinney
.\" Generated by docutils manpage writer.
.