[DRE-commits] [ruby-beautify] 09/10: Manpage updated.
Tomasz Nitecki
tnnn-guest at moszumanska.debian.org
Thu Apr 9 14:35:21 UTC 2015
This is an automated email from the git hooks/post-receive script.
tnnn-guest pushed a commit to branch master
in repository ruby-beautify.
commit a66ffe94ca64773ed2ec94a941cb956f177d707f
Author: Tomasz Nitecki <tnnn at tnnn.pl>
Date: Thu Apr 9 12:53:39 2015 +0200
Manpage updated.
---
debian/rbeautify.1 | 61 +-------------------------------
debian/rbeautify.1.txt | 39 ---------------------
debian/{rbeautify.1 => ruby-beautify.1} | 48 ++++++++++++++++++++-----
debian/ruby-beautify.1.txt | 62 +++++++++++++++++++++++++++++++++
4 files changed, 103 insertions(+), 107 deletions(-)
diff --git a/debian/rbeautify.1 b/debian/rbeautify.1
index 8da1ffa..3fe8629 100644
--- a/debian/rbeautify.1
+++ b/debian/rbeautify.1
@@ -1,60 +1 @@
-'\" t
-.\" Title: rbeautify
-.\" Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 10/22/2014
-.\" Manual: \ \&
-.\" Source: \ \&
-.\" Language: English
-.\"
-.TH "RBEAUTIFY" "1" "10/22/2014" "\ \&" "\ \&"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-rbeautify \- CLI binary that will pretty up Ruby code
-.SH "SYNOPSIS"
-.sp
-\fBrbeautify\fR [\fI\-h\fR] [\fI<file>\&...\fR]
-.SH "OPTIONS"
-.PP
-\fB\-h\fR
-.RS 4
-Show some help\&.
-.RE
-.PP
-\fB<file>\&...\fR
-.RS 4
-Pretty up provided file(s)\&.
-.RE
-.sp
-If it is run without specifying a filename, it will read from STDIN\&.
-.SH "HISTORY"
-.sp
-The original analyzer is available at: http://www\&.arachnoid\&.com/ruby/rubyBeautifier\&.html\&.
-.sp
-Original work is based on sublime\-text2 plugin: https://github\&.com/CraigWilliams/BeautifyRuby which was cleaned up and made suitable for use directly in a shell\&.
-.SH "AUTHOR"
-.sp
-Ernie Brodeur <ebrodeur at ujami\&.net>
-.sp
-This manpage was written by Tomasz Nitecki <tnnn at tnnn\&.pl> based on original README\&.md\&.
-.SH "DATE"
-.sp
-2014\-10\-22
+.so ruby-beautify.1
diff --git a/debian/rbeautify.1.txt b/debian/rbeautify.1.txt
deleted file mode 100644
index 778d849..0000000
--- a/debian/rbeautify.1.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-rbeautify(1)
-============
-:doctype: manpage
-
-NAME
-----
-rbeautify - CLI binary that will pretty up Ruby code
-
-SYNOPSIS
---------
-*rbeautify* ['-h'] ['<file>...']
-
-OPTIONS
--------
-*-h*::
- Show some help.
-
-*<file>...*::
- Pretty up provided file(s).
-
-If it is run without specifying a filename, it will read from STDIN.
-
-HISTORY
--------
-The original analyzer is available at: http://www.arachnoid.com/ruby/rubyBeautifier.html.
-
-Original work is based on sublime-text2 plugin: https://github.com/CraigWilliams/BeautifyRuby which was cleaned up and made suitable for use directly in a shell.
-
-AUTHOR
-------
-Ernie Brodeur <ebrodeur at ujami.net>
-
-This manpage was written by Tomasz Nitecki <tnnn at tnnn.pl> based on original README.md.
-
-DATE
-----
-2014-10-22
-
-// vim: set filetype=asciidoc:
diff --git a/debian/rbeautify.1 b/debian/ruby-beautify.1
similarity index 52%
copy from debian/rbeautify.1
copy to debian/ruby-beautify.1
index 8da1ffa..421c4f4 100644
--- a/debian/rbeautify.1
+++ b/debian/ruby-beautify.1
@@ -1,13 +1,13 @@
'\" t
-.\" Title: rbeautify
+.\" Title: ruby-beautify
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 10/22/2014
+.\" Date: 04/09/2015
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "RBEAUTIFY" "1" "10/22/2014" "\ \&" "\ \&"
+.TH "RUBY-BEAUTIFY" "1" "04/09/2015" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,10 +28,12 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-rbeautify \- CLI binary that will pretty up Ruby code
+ruby-beautify, rbeautify \- CLI binary that will pretty up Ruby code
.SH "SYNOPSIS"
.sp
-\fBrbeautify\fR [\fI\-h\fR] [\fI<file>\&...\fR]
+\fBruby\-beautify\fR [\fI\-hVts\fR] [\fI\-c <count>\fR] [\fI\-\-overwrite\fR] [\fI<file>\&...\fR]
+.sp
+\fBrbeautify\fR [\fI\-hVts\fR] [\fI\-c <count>\fR] [\fI\-\-overwrite\fR] [\fI<file>\&...\fR]
.SH "OPTIONS"
.PP
\fB\-h\fR
@@ -39,22 +41,52 @@ rbeautify \- CLI binary that will pretty up Ruby code
Show some help\&.
.RE
.PP
+\fB\-V\fR, \fB\-\-version\fR
+.RS 4
+Show version\&.
+.RE
+.PP
+\fB\-t\fR, \fB\-\-tabs\fR
+.RS 4
+Use tab(s) as indent character\&.
+.RE
+.PP
+\fB\-s\fR, \fB\-\-spaces\fR
+.RS 4
+Use space(s) as indent character\&.
+.RE
+.PP
+\fB\-c <count>\fR, \fB\-\-indent_count <count>\fR
+.RS 4
+Count of characters to use for indenting\&.
+.RE
+.PP
+\fB\-\-overwrite\fR
+.RS 4
+Overwrites file(s) in place\&. It won\(cqt overwrite files that fail syntax check\&.
+.RE
+.PP
\fB<file>\&...\fR
.RS 4
Pretty up provided file(s)\&.
.RE
.sp
If it is run without specifying a filename, it will read from STDIN\&.
+.SH "CONFIGURATION FILE"
+.sp
+Options presented above can be set inside a configuration file named \fB\&.ruby\-beautify\fR\&. It can be placed anywhere up in the directory tree\&. Options need to be separated by a new line and options that use parameter value require "=" to be added between parameter name and the value\&.
.SH "HISTORY"
.sp
-The original analyzer is available at: http://www\&.arachnoid\&.com/ruby/rubyBeautifier\&.html\&.
+The original analyzer that ruby\-beautify was based on is available at: http://www\&.arachnoid\&.com/ruby/rubyBeautifier\&.html\&.
.sp
Original work is based on sublime\-text2 plugin: https://github\&.com/CraigWilliams/BeautifyRuby which was cleaned up and made suitable for use directly in a shell\&.
+.sp
+Ruby\-beautify was recently re\-written to use the stdlib ripper gem to do the lexical analyzing\&. Consequently all of the old legacy code was dropped\&.
.SH "AUTHOR"
.sp
Ernie Brodeur <ebrodeur at ujami\&.net>
.sp
-This manpage was written by Tomasz Nitecki <tnnn at tnnn\&.pl> based on original README\&.md\&.
+This manpage was written by Tomasz Nitecki <tnnn at tnnn\&.pl> based on the original README\&.md\&.
.SH "DATE"
.sp
-2014\-10\-22
+2015\-04\-09
diff --git a/debian/ruby-beautify.1.txt b/debian/ruby-beautify.1.txt
new file mode 100644
index 0000000..3bab08e
--- /dev/null
+++ b/debian/ruby-beautify.1.txt
@@ -0,0 +1,62 @@
+rubybeautify(1)
+================
+:doctype: manpage
+
+NAME
+----
+ruby-beautify, rbeautify - CLI binary that will pretty up Ruby code
+
+SYNOPSIS
+--------
+*ruby-beautify* ['-hVts'] ['-c <count>'] ['--overwrite'] ['<file>...']
+
+*rbeautify* ['-hVts'] ['-c <count>'] ['--overwrite'] ['<file>...']
+
+OPTIONS
+-------
+*-h*::
+ Show some help.
+
+*-V*, *--version*::
+ Show version.
+
+*-t*, *--tabs*::
+ Use tab(s) as indent character.
+
+*-s*, *--spaces*::
+ Use space(s) as indent character.
+
+*-c <count>*, *--indent_count <count>*::
+ Count of characters to use for indenting.
+
+*--overwrite*::
+ Overwrites file(s) in place. It won't overwrite files that fail syntax check.
+
+*<file>...*::
+ Pretty up provided file(s).
+
+If it is run without specifying a filename, it will read from STDIN.
+
+CONFIGURATION FILE
+------------------
+Options presented above can be set inside a configuration file named *.ruby-beautify*. It can be placed anywhere up in the directory tree. Options need to be separated by a new line and options that use parameter value require "=" to be added between parameter name and the value.
+
+HISTORY
+-------
+The original analyzer that ruby-beautify was based on is available at: http://www.arachnoid.com/ruby/rubyBeautifier.html.
+
+Original work is based on sublime-text2 plugin: https://github.com/CraigWilliams/BeautifyRuby which was cleaned up and made suitable for use directly in a shell.
+
+Ruby-beautify was recently re-written to use the stdlib `ripper` gem to do the lexical analyzing. Consequently all of the old legacy code was dropped.
+
+AUTHOR
+------
+Ernie Brodeur <ebrodeur at ujami.net>
+
+This manpage was written by Tomasz Nitecki <tnnn at tnnn.pl> based on the original README.md.
+
+DATE
+----
+2015-04-09
+
+// vim: set filetype=asciidoc:
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-beautify.git
More information about the Pkg-ruby-extras-commits
mailing list