[DRE-commits] [ruby-ramaze] 01/01: Reword the manual to comply with current usage

Gunnar Wolf gwolf at alioth.debian.org
Fri Aug 30 22:18:18 UTC 2013


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

gwolf pushed a commit to branch master
in repository ruby-ramaze.

commit 9ac4423f3b419921754b0b0c6f24b3176386cf16
Author: Gunnar Wolf <gwolf at debian.org>
Date:   Fri Aug 30 17:18:08 2013 -0500

    Reword the manual to comply with current usage
---
 debian/ramaze.1 |   52 ++++++++++++++++++++++++++--------------------------
 1 file changed, 26 insertions(+), 26 deletions(-)

diff --git a/debian/ramaze.1 b/debian/ramaze.1
index a10c9ac..183f84a 100644
--- a/debian/ramaze.1
+++ b/debian/ramaze.1
@@ -1,37 +1,37 @@
-.TH ramaze 1 "May 27, 2010"
+.TH ramaze 1 "Aug 30, 2013"
 .SH NAME
-ramaze \- This little tool helps you creating, controlling, and debugging your applications.
+ramaze \- Create Ramaze Web applications.
 .SH SYNOPSIS
 .B ramaze
-[options] [INPUT] 
+[COMMAND] [OPTIONS]
 .SH DESCRIPTION
 ramaze binary tightly integrates with both Ramaze and the Rack executable rackup, so you will be able to take advantage of both.
 .SH OPTIONS
 .TP 8
-.B create
-To create a new application with a basic set of files and directories.
+.B create \f2application_name\f1
+Create a new Ramaze application; the application name should be
+provided as the only option.
 .TP 8
-.B start
-Start an instance of your application with ramaze start. Supply a pidfile name if you do not want it to use the default (PROJECT.pid).
+.B \-v \-\-version
+Shows the version of Ramaze
 .TP 8
-.B start \-D                    
-To start your application in the background you should daemonize it with the \-D argument. This will put the PID of the instance into the pidfile.
-.TP 8
-.B stop                      
-Stop a running instance of this application with ramaze stop. Supply a pidfile name if you started it with a pidfile other than the default (PROJECT.pid).
-.TP 8
-.B restart                 
-Stop a running instance of this application, then starts it back up with ramaze restart. Pidfile (if supplied) is used for both stop and start.
-.TP 8
-.B console                
-Starts an irb console with app.rb (and irb completion) loaded. This command ignores rack options.At the moment, you will have to call Ramaze.setup_dependencies after starting the session to get full functionality.
-.TP 8
-Print version
+.B \-h \-\-help
+Shows a brief help message
+.SH Controlling your application
+.Pp
+Note that in previous versions, this binary had several options for
+controlling your Ramaze Web applications, via \f2start\f1, \f2stop\f1
+and \f2restart\f1, as well as debugging them, via \f2console\f1.
+Those methods are now available through \f2Rake\f1 tasks; to list the
+available Rake tasks run, from inside your project directory,
+
+.RS 8m
+rake \-T
+.RE
 .SH SEE ALSO
-This program is shipped as part of the libramaze\-ruby1.8 library
-package, you can check its corresponding documentation can be found in
-the libramaze\-ruby\-doc package.
+This program is shipped as part of the ruby\-ramaze library
+package.
 .SH AUTHOR
-This manual page was written by Deepak Tripathi <apenguinlinux at gmail.com>,
-based on the document of this program, for the Debian GNU/Linux system 
-(but may be freely used by others).
+This manual page was written by Gunnar Wolf <gwolf at debian.org>, based
+on the document of this program, for the Debian GNU/Linux system (but
+may be freely used by others).

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



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