[Python-modules-commits] [python3-proselint] 05/07: Update d/proselint.1 manpage for v0.7.0
Víctor Cuadrado Juan
viccuad-guest at moszumanska.debian.org
Sun Nov 6 17:52:06 UTC 2016
This is an automated email from the git hooks/post-receive script.
viccuad-guest pushed a commit to branch master
in repository python3-proselint.
commit 9bbb5782605c46a735d3a9272d00d1b35b824713
Author: Víctor Cuadrado Juan <me at viccuad.me>
Date: Sun Nov 6 18:11:10 2016 +0100
Update d/proselint.1 manpage for v0.7.0
---
debian/proselint.1 | 50 +++++++++++++++++++++++---------------------------
1 file changed, 23 insertions(+), 27 deletions(-)
diff --git a/debian/proselint.1 b/debian/proselint.1
index dbae09f..60093b7 100644
--- a/debian/proselint.1
+++ b/debian/proselint.1
@@ -1,42 +1,38 @@
-.TH proselint "1" "28 February 2016" "proselint" ""
-
+.TH "PROSELINT" "1" "06-Nov-2016" "" "proselint Manual"
.SH NAME
-proselint \- A prose lint command-line utility
-
+proselint \- A CLI for proselint, a linter for prose.
.SH SYNOPSIS
.B proselint
-.RI [ options ]
-
+[OPTIONS] [PATHS]...
.SH DESCRIPTION
-Proselint is a command-line utility that aggregates knowledge about best
-practices in writing from world's greatest writers and editors, and makes it
-accessible by giving suggestions in the form of a linter for prose.
+A CLI for proselint, a linter for prose.
+.SH DESCRIPTION
+Proselint is a CLI for proselint, a linter for prose. It is an utility that
+aggregates knowledge about best practices in writing from world's greatest
+writers and editors, and makes it accessible by giving suggestions in the form
+of a linter for prose.
.SH OPTIONS
-Proselint accepts the following options:
-.TP
-If no file is provided, proselint will run the included demo.md.
-.TP
-.B "--help"
-Show help options
.TP
-.B "--version, --whatever"
-Print version string and exit
+\-v, \-\-version
+Show the version and exit.
.TP
-.B "--i, --initialize"
-Run the initialization
+\-d, \-\-debug
+Give verbose output.
.TP
-.B "--d, --debug"
-Output debug information
+\-c, \-\-clean
+Clear the cache.
.TP
-.B "--s, --score"
-Output lint score
+\-j, \-\-json
+Output as JSON.
.TP
-.B "--j, --json"
-Display the errors in json format
+\-t, \-\-time
+Time on a corpus.
.TP
-.B "--t, --time"
-Run a timing test, useful for developing (needs a populated corpora/ directory)
+\-\-demo
+Run over demo file.
.TP
+\-\-compact
+Shorten output.
.SH "ADDITIONAL INFORMATION"
For further information, visit the website http://proselint.com.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python3-proselint.git
More information about the Python-modules-commits
mailing list