Package: link-grammar Version: 4.2.2-1 Severity: wishlist Tags: patch The man page for link-grammar wasn't very useful. I spent a good half an hour or so working out problems with how exactly to even use the program. So, I wrote up what I've learned, messed around with some groff stuff, and added a new section to the man page on usage. I think it could be helpful, so I'm submitting a diff of the "before" and "after" as a bug and also sending it as an email to Ken Bloom (in case Debian's bug tracking system doesn't allow text file attachments; I'm not very familiar with it). I hope my writing and formatting is at least salvageable (I've never before had occasion to mess with man pages), and that I can look forward to a better man page at the next link-grammar release. As far as copyright is concerned, you use whatever license you like: public domain, modified BSD, GFDL, etc.
~maru
5c5 < .TH LINK-GRAMMAR 1 "April 23, 2006" --- > .TH LINK-GRAMMAR 1 "November 3, 2005" 34c34 < not cross, and the words form a consistent connected graph. The authors encoded --- > not cross, and the words form a connected graph. The authors encoded 57,110c57 < .B -<special "!" command> \"Can special commands be commandline arguments? < .SH USE < .PP < link-grammar, when invoked manually, will take control of the < terminal; link-grammar will then attempt to analyze the grammar of < all input, unless escaped with an exclamation mark, according to the < dictionary file provided as an argument. If escaped, the input < will be treated as a "special command"; "!help" lists all special < commands available. < .PP < link-grammar depends on a link-grammar dictionary which contains < lists of words and associated metadata about their grammatical < properties in order to analyze sentences. A link-grammar dictionary < provided by the authors of link-grammar is usually included with the < link-grammar package, and can often be found somewhere in the < /usr/share/link-grammar/ hierarchy. Alternatively, a user can provide < their own dictionary as an argument. Hence, a possible command would < be: < .TP < .B link-grammar /usr/share/link-grammar/en/4.0.dict < .PPP < Run link-grammar using the 4.0 version of the English dictionary. < .PP < While in a link-grammar session, some example output could be: < .PP < .RS < .B linkparser> Reading a man page is informative. < .PP < ++++Time 0.00 seconds (0.01 < total) < .PP < Found 1 linkage (1 had no P.P. violations) < Unique linkage, cost vector = (UNUSED=0 DIS=0 AND=0 LEN=12) < < +------------------------Xp-----------------------+ < | +---------Ss*g---------+ | < | +-------Os-------+ | | < | | +----Ds----+ | | < +----Wd---+ | +--AN--+ +---Pa---+ | < | | | | | | | | < .PP < LEFT-WALL reading.g a man.n page.n is.v informative.a . < .RE < .PP < link-grammar can also be used non-interactively, either through its < API, or via the -batch option. When used with the -batch option, < link-grammar passively receives input from standard input, and when < the stream finishes, it then outputs its analysis. So one could < construct an ad-hoc grammar checker by piping text through < link-grammar with a batch option, and seeing what sentences fail to < parse as valid: < .RS < .B cat thesis.txt | link-grammar /usr/share/link-grammar/en/4.0.dict -batch < .RE --- > .B -<special "!" command>
