[DRE-commits] [ruby-cassiopee] 02/07: Extend cassie(1) manual page

Cédric Boutillier boutil at alioth.debian.org
Tue Sep 3 22:38:57 UTC 2013


This is an automated email from the git hooks/post-receive script.

boutil pushed a commit to annotated tag debian/0.1.10-1
in repository ruby-cassiopee.

commit 1780bd1f03b0b9e4cb052c525b6686741b7f1a97
Author: Cédric Boutillier <boutil at debian.org>
Date:   Tue Sep 3 23:48:43 2013 +0200

    Extend cassie(1) manual page
---
 debian/cassie.1  |   37 ++++++++++++++++++++++++++++++++++---
 debian/changelog |    1 +
 2 files changed, 35 insertions(+), 3 deletions(-)

diff --git a/debian/cassie.1 b/debian/cassie.1
index 93a75af..a0f63fb 100644
--- a/debian/cassie.1
+++ b/debian/cassie.1
@@ -3,7 +3,7 @@
 cassie \- search a string in another string with errors allowed
 .SH SYNOPSIS
 .B cassie
-[\-h]
+[\fIoptions\fP]
 .SH DESCRIPTION
  Cassie is a wrapper above Cassiopee library to search in a string an
  other string, allowing Hamming or edit distance between them.
@@ -11,8 +11,39 @@ cassie \- search a string in another string with errors allowed
 .PP
 .SH OPTIONS
 .TP
-\-h
-display the list of commands.
+\fB\-h\fP, \fB\-\-help
+Display the list of commands.
+.TP
+\fB\-v\fP, \fB\-\-verbose\fP
+Output more information.
+.TP
+\fB\-f\fP, \fB\-\-filter \fIFILTER\fP
+Filter matches between min and max positions ex. 100-150.
+.TP
+\fB\-i\fP, \fB\-\-index\fP \fIFILE\fP
+File to index.
+.TP
+\fB\-\-fpattern\fP \fIFILE\fP
+File with pattern.
+.TP
+\fB\-p\fP, \fB\-\-pattern\fP \fIPATTERN\fP
+Search pattern.
+.TP
+\fB\-s\fP, \fB\-\-store\fP \fIFILE\fP
+Store index to file.
+.TP
+\fB\-n\fP, \fB\-\-name\fP \fINAME\fP
+Name of index. The default value is \fIcrawler\fP.
+.TP
+\fB\-x\fP, \fB\-\-exact\fP
+Do exact search. This is the default behaviour.
+.TP
+\fB\-m\fP, \fB\-\-hamming\fP \fIERROR\fP
+Maximum number of errors to search with Hamming distance.
+.TP
+\fB\-e\fP, \fB\-\-edit \fIERROR\fP
+Maximum number of errors to search with edit(levenshtein) distance
+
 .PP
 .SH AUTHOR
 Olivier Sallou (olivier.sallou (at) irisa.fr)
diff --git a/debian/changelog b/debian/changelog
index c1c501b..b3823b2 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -6,6 +6,7 @@ ruby-cassiopee (0.1.10-1) UNRELEASED; urgency=low
 
   [ Cédric Boutillier ]
   * use standalone License paragraph
+  * Extend cassie(1) manual page
 
  -- Nitesh A Jain <niteshjain92 at gmail.com>  Wed, 03 Jul 2013 22:20:04 +0530
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-cassiopee.git



More information about the Pkg-ruby-extras-commits mailing list