[DRE-commits] r5626 - trunk/libcompass-ruby/debian

[Deepak Tripathi]

Author: deepak-guest
Date: 2010-06-22 08:25:25 +0000 (Tue, 22 Jun 2010)
New Revision: 5626

Added:
   trunk/libcompass-ruby/debian/compass.1
Log:
Added man page for compass


Added: trunk/libcompass-ruby/debian/compass.1
===================================================================
--- trunk/libcompass-ruby/debian/compass.1	                        (rev 0)
+++ trunk/libcompass-ruby/debian/compass.1	2010-06-22 08:25:25 UTC (rev 5626)
@@ -0,0 +1,106 @@
+.TH compass 1 "June 22, 2010"
+.SH NAME
+compass \- The compass command line tool will help you create and manage the stylesheets for your project.
+.SH SYNOPSIS
+.B compass
+[options] [project]
+.SH DESCRIPTION
+The compass command line tool will help you create and manage the stylesheets for your project.
+.SH Mode Options (only specify one)
+.TP 8
+.B \-i, \-\-install
+Create a new compass project.The default mode when a project is provided.
+.TP 8
+.B \-u, \-\-update
+Update the current project.This is the default when no project is provided.
+.TP 8
+.B \-w, \-\-watch
+Monitor the current project for changes and update                      
+.TP 8
+.B \-p,\-\-pattern
+Stamp out a pattern into the current project.Must be used with -f.                      
+.TP 8
+.B \-\-write-configuration
+Write the current configuration to the configuration file.                 
+.TP 8
+.B \-\-list-frameworks                
+List compass frameworks available to use
+.TP 8
+.B \-\-validate
+Validate your project's compiled css. Requires Java.                
+.TP 8
+.B \-\-grid-img [DIMENSIONS]               
+Generate a background image to test grid alignment.
+Dimension is given as <column_width>+<gutter_width>.Defaults to 30+10.
+.SH Install/Pattern Options:
+.TP 8
+.B \-f, \-\-framework FRAMEWORK
+Use the specified framework. Only one may be specified.             
+.TP 8
+.B \-n, \-\-pattern\-name NAME                      
+The name to use when stamping a pattern.Must be used in combination with \-p
+Sets the project type to a rails project.
+.TP 8
+.B \-?, \-h, \-\-help                   
+Show a usage summary
+.SH Configuration Options:
+.TP 8
+.B \-c, \-\-config CONFIG_FILE                     
+Specify the location of the configuration file explicitly.
+.TP 8
+.B \-\-sass\-dir SRC_DIR           
+The source directory where you keep your sass stylesheets
+.TP 8
+.B \-\-css\-dir CSS_DIR            
+The target directory where you keep your css stylesheets.
+.TP 8
+.B  \-\-images\-dir IMAGES_DIR
+The directory where you keep your images.
+.TP 8
+.B \-\-javascripts\-dir JS_DIR    
+The directory where you keep your javascripts
+.TP 8
+.B \-e, \-\-environment ENV
+Use sensible defaults for your current environment.
+.TP 8 
+.B \-s, \-\-output\-style STYLE
+Select a CSS output mode.
+.TP 8 
+.B \-\-relative\-assets
+Make compass asset helpers generate relative urls to assets.
+.SH General Options:
+.TP 8
+.B \-r, \-\-require LIBRARY
+Require the given ruby LIBRARY before running commands
+.TP 8
+.B  \-q, \-\-quiet
+Quiet mode.
+.TP 8
+.B  \-\-dry\-run
+Dry Run. Tells you what it plans to do.
+.TP 8
+.B  \-\-trace
+Show a full stacktrace on error
+.TP 8 
+.B \-\-force
+Force. Allows some failing commands to succeed instead.
+.TP 8 
+.B \-\-imports
+Emit an imports suitable for passing to the sass command-line. 
+.TP 8
+.B \-\-install\-dir
+Emit the location where compass is installed. 
+.TP 8
+.B  \-?, \-h, \-\-help
+Show this message 
+.TP 8
+.B  \-v, \-\-version
+Print version 
+.SH SEE ALSO
+This program is shipped as part of the libcompass\-ruby1.8 library
+package, you can check its corresponding documentation can be found in
+the libcompass\-ruby\-doc package.
+.SH AUTHOR
+This manual page was written by Deepak Tripathi<apenguinlinux at gmail.com>,
+based on the command\-line output of this program, for the Debian GNU/Linux
+system (but may be freely used by others).