annotate runtime/tools/ccfilter.1 @ 20545:69d7432bec0a

Added tag v8.2.0826 for changeset e8132bec4b0fc3af617381ee8289c4de39370cf7
author Bram Moolenaar <Bram@vim.org>
date Tue, 26 May 2020 11:15:05 +0200
parents 2b30a2b4bde2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 .TH ccfilter 1 "01-Apr-97"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2 .SH NAME
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 ccfilter \- a compiler's output filter for vim quickfix
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 .SH SYNOPSIS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5 ccfilter [
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6 .B <options>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 ]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8 .SH DESCRIPTION
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 The ccfilter utility "filters" the output of several compilers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 and makers (make/gmake) from several platforms (see NOTES below)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 to a standardized format which easily fits in vim's quickfix
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 feature. For further details, see in vim ":help quickfix".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 ccfilter reads
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 .B 'stdin'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 and outputs to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 .B 'stdout'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 \.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 .PP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 The need for ccfilter is clear, as some compilers have irregular
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 and/or multiple line error messages (with the relevant information on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 line 2), which makes it impossible for the errorformat to correctly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 display them !
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 When working on different platforms, and with different compilers,
14999
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 7
diff changeset
26 ccfilter eases the utilization of quickfix, due to its standardized
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 output, allowing to have in .vimrc a plain
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 .B \ \ \ \ :set\ errorformat=%f:%l:%c:%t:%m
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 .SH USAGE
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 When using ccfilter, one would include the following lines in .vimrc:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 .B \ \ \ \ :set shellpipe=\\\\|&ccfilter\\\\>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 .br
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 .B \ \ \ \ :set errorformat=%f:%l:%c:%t:%m
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 .SH OPTIONS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 .TP 16
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 -c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 Decrement column by one. This may be needed, depending on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 the compiler being used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 -r
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 Decrement row by one. This may be needed, depending on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 the compiler being used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 -v
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 Verbose (Outputs also invalid lines).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 This option makes ccfilter output also the lines that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 couldn't be correctly parsed. This is used mostly for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 ccfilter debugging.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 -o <COMPILER>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 Treat input as <COMPILER>'s output.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 Even when configuring ccfilter to assume a default
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 COMPILER, sometimes it's helpful to be able to specify
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 the COMPILER used to generate ccfilter's input.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 For example, when cross-compiling on a network from a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 single machine.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 -h
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 Shows a brief help, describing the configured default COMPILER
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 and the valid parameters for COMPILER.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 .SH NOTES
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 Currently, ccfilter accepts output from several compilers, as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 described below:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 .TP 10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 GCC
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 GCC compiler
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 AIX
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 AIX's C compiler
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 ATT
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 AT&T/NCR's High Performance C Compiler
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 IRIX
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 IRIX's MIPS/MIPSpro C compiler
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 SOLARIS
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 SOLARIS's SparcWorks C compiler
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 .TP
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 HPUX
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 HPUX's C compiler
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 .SH AUTHOR
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 .B ccfilter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 was developed by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 .B Pablo Ariel Kohan
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 .BR
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 .B mailto:pablo@memco.co.il