runtime/tools/ccfilter.1

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