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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
*unite-quickfix.txt*	Source for unite.vim that shows outputs from quickfix


==============================================================================
Index						*unite_quickfix-contents*

INTRODUCTION			|unite_quickfix-introduction|
USAGE				|unite-quickfix-usage|
SETTINGS			|unite-quickfix-setting|
  VARIABLES			  |unite-quickfix-variables|
EXAMPLES			|unite-quickfix-example|


==============================================================================
INTRODUCTION					*unite_quickfix-introduction*


|unite_quickfix| is a |unite-source| for outputting |quickfix|
(|location-list|) data to |unite.vim|, a plugin written by Shougo.

unite.vim - github : https://github.com/Shougo/unite.vim


|unite-qf|, written by sgur, is similar to this plugin.

unite-qf - github : https://github.com/sgur/unite-qf


There are several differences between |unite-quickfix| and |unite-qf| including:

- Support for is_multiline
 - Lines that do not fit in one line can be wrapped and shown in following
   lines.
 - |g:unite_quickfix_is_multiline|

- Use previous quickfix outputs with |:colder| and |:cnewer|
 - |unite-quickfix-usage|

- Show shortened file paths using |pathshorten()|
 - |g:unite_quickfix_filename_is_pathshorten|

- Outputs from location_list
 - :Unite location_list

- Highlighting
 - see: http://d.hatena.ne.jp/osyo-manga/20130326/1364298157

- Character code conversion is not supported


==============================================================================
USAGE						*unite-quickfix-usage*

Start |unite.vim| after sending outputs to |quickfix|.

>
	" Use output to quickfix as source
	:Unite quickfix
	
	" Use output to location-list as source
	:Unite location_list
	
	" Use quickfix output prior to the current as source.
	" Only the output to unite.vim is modified.
	" Note that :colder is not actually executed.
	:Unite quickfix:2
	
	" Behaviour similar to quickfix
	" Open unite.vim at the bottom (-direction=botright),
	" and don't quit unite.vim (-no-quit) after selecting candidate.
	:Unite -no-quit -direction=botright quickfix
<


==============================================================================
SETTINGS						*unite-quickfix-setting*


------------------------------------------------------------------------------
VARIABLES					*unite-quickfix-variables*

g:unite_quickfix_filename_is_pathshorten	*g:unite_quickfix_filename_is_pathshorten*
	Choose whether or not to show shortened file name.

	0 : Don't shorten
	1 : Shorten

Default: >
	let unite_quickfix_filename_is_pathshorten = 1
<


g:unite_quickfix_is_multiline			*g:unite_quickfix_is_multiline*
	Whether or not to show lines that go beyond the width of the window in
	multiple lines.

	0 : Don't show in multiple lines
	1 : Show in multiple lines

Default: >
	let g:unite_quickfix_is_multiline = 1
<

	*g:unite#filters#converter_quickfix_highlight#enable_bold_for_message*
g:unite#filters#converter_quickfix_highlight#enable_bold_for_message
	Setting bold type for error message.

	0 : No bold type
	1 : bold type

Default: >
	let g:unite#filters#converter_quickfix_highlight#enable_bold_for_message = 1
<

------------------------------------------------------------------------------
HIGHLIGHTS					*unite-quickfix-highlight*

Highlights to be applied at converter_quickfix_highlight.


UniteQuickFixError		*unite-quickfix-highlight-UniteQuickFixError*
	Setting the highlight of "error".
	"error" のハイライトを設定します。
Default: >
	highlight UniteQuickFixError ctermfg=1 guifg=Red term=bold gui=bold
<

UniteQuickFixWarning		*unite-quickfix-highlight-UniteQuickFixWarning*
	Setting the highlight of "warning".
Default: >
	highlight UniteQuickFixWarning ctermfg=1 guifg=Purple
<

==============================================================================
EXAMPLES					*unite-quickfix-example*

Enable highlighting			*unite-quickfix-example-highlight*
You need to configure unite-filters in order to enable highlighting.
Highlighting does not work with the -multi-line option. You need to use -wrap
in order for it to work.

Example: >
	" Disable multi-line
	let g:unite_quickfix_is_multiline=0
	
	" Set converter_quickfix_highlight as the converter
	call unite#custom_source('quickfix', 'converters', 'converter_quickfix_highlight')
	call unite#custom_source('location_list', 'converters', 'converter_quickfix_highlight')

	" Highlighting does not work correctly unless used with -wrap option
	:Unite quickfix -wrap
<


==============================================================================
vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl:noet