This repository has been archived by the owner on Nov 24, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27
/
atdtool.1
109 lines (75 loc) · 2.18 KB
/
atdtool.1
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
.TH "atdtool" 1 "" ""
.SH NAME
.P
atdtool \- After the Deadline command\-line tool
.SH SYNOPSIS
.P
\fBatdtool\fR \-h
.P
\fBatdtool\fR [\-e/error] [\-k/key=<key>] <files...>
.P
\fBatdtool\fR [\-e/error] [\-k/key=<key>] \-l/\-\-language <fr/de/pt/es> <files...>
.P
\fBatdtool\fR [\-e/error] [\-k/key=<key>] \-s/\-\-server <server> <files...>
.SH DESCRIPTION
.P
\fBatdtool\fR 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.
.P
\fBAfter the Deadline\fR is a language checker that is able to:
.RS
.IP \(bu 3
spell check contextually
.IP \(bu 3
check style
.IP \(bu 3
check grammar
.RE
.P
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.
.SH OPTIONS
.P
\fB\-h\fR Help.
.P
\fB\-e, \-\-error\fR Exit with error when any error is found.
.P
\fB\-k, \-\-key=<key>\fR Selects the key to use. AtD servers cache results based on
this parameter.
.P
\fB\-l, \-\-language=[fr/de/pt/es]\fR Selects the language. This affects the server used.
.P
\fB\-s, \-\-server=<server>\fR Use a custom server.
.SH Vim integration
.P
atdtool can be used as a \fIquickfix\fR program in Vim with the following command:
.nf
:set makeprg=atdtool\e %
.fi
.P
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.
.P
More information on quickfix can be found with :help quickfix in Vim or at
http://vimdoc.sourceforge.net/htmldoc/quickfix.html
.SH AUTHORS
.P
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.
.SH REPORTING BUGS
.P
https://github.com/lpenz/atdtool/issues/new
.SH COPYRIGHT
.P
Copyright (C) 2010 Leandro Lisboa Penz <[email protected]>
.SH SEE ALSO
.RS
.IP \(bu 3
http://www.afterthedeadline.com/
.IP \(bu 3
http://bitbucket.org/miguelventura/after_the_deadline/wiki/Home.
.RE
.\" man code generated by txt2tags 2.6 (http://txt2tags.org)
.\" cmdline: txt2tags -t man -i manual.t2t -o atdtool.1