forked from lpenz/atdtool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmanual.t2t
82 lines (39 loc) · 1.78 KB
/
manual.t2t
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
atdtool
= NAME =
atdtool - After the Deadline command-line tool
= SYNOPSIS =
**atdtool** -h
**atdtool** [-e/--error] [-k/--key=<key>] <files...>
**atdtool** [-e/--error] [-k/--key=<key>] -l/--language <fr/de/pt/es> <files...>
**atdtool** [-e/--error] [-k/--key=<key>] -s/--server <server> <files...>
= DESCRIPTION =
**atdtool** is a command-line tools that contacts an After the Deadline language
service and displays the errors reported by the service in a format very similar
to gcc's.
**After the Deadline** is a language checker that is able to:
- spell check contextually
- check style
- check grammar
The official server is free for personal use. They provide a free server for
commercial use. atdtool can be used with the default server or with a
custom one.
= OPTIONS =
**-h** Help.
**-e, --error** Exit with error when any error is found.
**-k, --key=<key>** Selects the key to use. AtD servers cache results based on
this parameter.
**-l, --language=[fr/de/pt/es]** Selects the language. This affects the server used.
**-s, --server=<server>** Use a custom server.
= Vim integration =
atdtool can be used as a //quickfix// program in Vim with the following command:
``` :set makeprg=atdtool\ %
You can then use ``:make`` to check the current buffer and navigate the errors
with the quickfix window, the same way gcc's errors can be navigated.
More information on quickfix can be found with ``:help quickfix`` in Vim or at
http://vimdoc.sourceforge.net/htmldoc/quickfix.html
= AUTHORS =
Written by [Leandro Penz http://lpenz.github.com], based on the python bindings
by Miguel Ventura at http://bitbucket.org/miguelventura/after_the_deadline/wiki/Home.
= SEE ALSO =
- http://www.afterthedeadline.com/
- http://bitbucket.org/miguelventura/after_the_deadline/wiki/Home.