Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Consider adding a manpage for tt tool. #37

Merged
merged 1 commit into from

2 participants

@boutil

Debian distribution requires packages in /usr/bin to have a manual page.
This is a manpage written by Carl Worth, and slightly updated by myself
for the Debian project.

Please consider including this manpage in later versions if you find it useful.

Cédric Boutillier Add manpage for tt binary
Debian distribution requires packages in /usr/bin to have a manual page.
This is a manpage written by Carl Worth, and slightly updated by myself
for the Debian project.
b4505e5
@cjheath
Collaborator

Thankyou, but in future please direct pull requests to the project homepage (see https://rubygems.org/gems/treetop).

@cjheath cjheath merged commit d037cce into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jun 19, 2013
  1. Add manpage for tt binary

    Cédric Boutillier authored
    Debian distribution requires packages in /usr/bin to have a manual page.
    This is a manpage written by Carl Worth, and slightly updated by myself
    for the Debian project.
This page is out of date. Refresh to see the latest.
Showing with 83 additions and 0 deletions.
  1. +83 −0 doc/tt.1
View
83 doc/tt.1
@@ -0,0 +1,83 @@
+.\" treetop - Bringing the simplicity of Ruby to syntactic analysis
+.\"
+.\" Copyright (c) 2007 Nathan Sobo.
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining a copy
+.\" of this software and associated documentation files (the "Software"), to deal
+.\" in the Software without restriction, including without limitation the rights
+.\" to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+.\" copies of the Software, and to permit persons to whom the Software is
+.\" furnished to do so, subject to the following conditions:
+.\"
+.\" The above copyright notice and this permission notice shall be included in
+.\" all copies or substantial portions of the Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+.\" AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+.\" OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+.\" THE SOFTWARE.
+.TH tt 1 2013-06-19 Treetop "Treetop v1.4.14"
+.SH NAME
+tt \- Compile a treetop grammar file to ruby source code
+.SH SYNOPSIS
+.B tt
+.RI [ options "] " grammar_file "[.treetop|.tt] ..."
+
+.SH DESCRIPTION
+The
+.B tt
+program is a command-line script to compile .treetop files into Ruby
+source code.
+
+The
+.B tt
+program takes a list of files with a .treetop extension and compiles
+them into .rb files of the same name. You can then require these files
+like any other Ruby script.
+
+Alternately, you can supply just one .treetop file and a \-o flag to
+specify the name of the output file.
+
+Note: while treetop grammar files
+.B must
+have a supported filename extensions, (.treetop or .tt), the extension
+name is not required when calling the compiler with grammar file
+names.
+.SH OPTIONS
+.TP 4
+.BI "\-o, \-\-output" " FILENAME"
+
+Write parser source to
+.I FILENAME.
+.TP 4
+.B \-f, \-\-force
+
+Overwrite existing output file(s)
+.TP 4
+.B \-v, \-\-version
+
+Show Treetop version
+.TP 4
+.B \-h, \-\-help
+
+.SH EXAMPLES
+.TP 4
+1 grammar -> 1 parser source
+
+tt foo.tt
+.TP 4
+2 grammars -> 2 separate parsers
+
+tt foo bar.treetop
+.TP 4
+Alternately named output file
+
+tt \-o alterate_name.rb foo
+.SH SEE ALSO
+
+The treetop website:
+
+.B http://treetop.rubyforge.org
Something went wrong with that request. Please try again.