[varnamc] Added manpages for varnamc

CMakeLists.txt

@@ -126,6 +126,7 @@ INSTALL ( FILES schemes/hi.vst DESTINATION ${CMAKE_INSTALL_PREFIX}/share/varnam/
 INSTALL ( FILES schemes/ml.vst DESTINATION ${CMAKE_INSTALL_PREFIX}/share/varnam/vst OPTIONAL)
 INSTALL ( FILES varnamruby.rb DESTINATION ${CMAKE_INSTALL_PREFIX}/lib)
 INSTALL_PROGRAMS(/bin FILES varnamc)
+INSTALL ( FILES varnamc.1 DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man1)
 
 IF(MSVC)
         target_link_libraries(${VARNAM_LIBRARY_NAME})

makedistro.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -e
 tmp_dir_create_command="mktemp -d"
 unamestr=`uname`
 if [[ "$unamestr" == 'Darwin' ]]; then

varnamc.1

@@ -0,0 +1,79 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" (C) Copyright 2014 Navaneeth K N <[email protected]>,
+.\"
+
+.TH varnamc 1 "March  2, 2014"
+.SH NAME
+varnamc \- Command line client to libvarnam
+.SH SYNOPSIS
+.B varnamc
+\fIoptions args\fR
+.SH DESCRIPTION
+Provides a command line interface to libvarnam. This can be used to perform transliteration, reverse transliteration and learn.
+.PP
+varnamc requires Ruby 1.9.x or later to be installed.
+.SH OPTIONS
+.TP
+\fB\-l\fR, \fB\-\-library\fR FILE
+Sets the varnam library
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Enable verbose output
+.TP
+\fB\-t\fR, \fB\-\-transliterate\fR TEXT
+Transliterate the given text
+.TP
+\fB\-\-indic\-digits\fR
+Turns on indic digit rendering while transliterating
+.HP
+\fB\-r\fR, \fB\-\-reverse\-transliterate\fR TEXT Reverse transliterate the given text
+.TP
+\fB\-n\fR, \fB\-\-learn\fR [TEXT]
+Learn the given text
+.TP
+\fB\-a\fR, \fB\-\-train\fR PATTERN=WORD
+Train varnam to use PATTERN for WORD
+.TP
+\fB\-f\fR, \fB\-\-learn\-from\fR FILE|DIRECTORY
+Reads from the specified file/directory
+.TP
+\fB\-\-train\-from\fR FILE|DIRECTORY
+Reads the specified file/directory and trains all the words specified
+.TP
+\fB\-e\fR, \fB\-\-export\-words\fR
+Export words to the output directory
+.TP
+\fB\-\-export\-full\fR
+Export words & patterns to the output directory
+.TP
+\fB\-\-import\-learnings\-from\fR FILE|DIRECTORY
+Import learned data from the specified file/directory
+.TP
+\fB\-s\fR, \fB\-\-symbols\fR VALUE
+Sets the symbols file
+.TP
+\fB\-c\fR, \fB\-\-compile\fR FILE
+Compile symbols file
+.TP
+\fB\-\-learnings\-file\fR FILE
+Specify the file to store all learnings
+.TP
+\fB\-\-detect\-language\fR WORD
+Detect language of the word
+.TP
+\fB\-d\fR, \fB\-\-output\-dir\fR dir
+Sets the output directory
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display this screen
+.TP
+\fB\-\-version\fR
+Display version
+.SH "BUGS"
+To report bugs, visit - http://savannah.nongnu.org/bugs/?group=varnamproject
+.SH "COPYRIGHT"
+(C) Copyright 2014 Navaneeth K N <[email protected]>
+.SH "CONTACT"
+[email protected]
+.SH "NOTES"
+The full documentation is maintained at http://wwww.varnamproject.com