smor        2003/03/26 02:40:59

  Added:       src/man  maven.1
  Log:
  Added a man file for Maven.
  
  Linux users may find it useful, as a replacement for "maven -h".
  We can benefit from man-reading existing softwares as well.
  
  Now, I need to have it installed along with Maven ...
  
  Revision  Changes    Path
  1.1                  maven/src/man/maven.1
  
  Index: maven.1
  ===================================================================
  .\" Process this file with
  .\" groff -man -Tascii foo.1
  .\"
  .TH MAVEN 1 "MARCH 2003" Linux "User Manuals"
  .SH NAME
  maven \- builds a project
  .SH SYNOPSIS
  \fB maven\fR [\fIoptions\fR] \fIgoal\fR ...
  .SH DESCRIPTION
  .B Maven
  is a Java project management and project comprehension tool. Maven is
  based on the concept of a project object model (\fBPOM\fR) in that all the 
  artifacts produced by Maven are a result of consulting a well defined model for
  your project. Builds, documentation, source metrics, and source cross-references
  are all controlled by your POM.
  
  Maven has many goals , but in a nutshell Maven aims to make the developer's
  life easier by providing a well defined project structure, well defined
  development processes to follow, and a coherent body of documentation that
  keeps your developers and clients apprised of what's happening with your
  project. Maven alleviates a lot of what most developers consider drudgery and
  lets them get on with the task at hand. This is essential in OSS projects where
  there aren't many people dedicated to the task of documenting and propagating
  the critical information about your project which is necessary in order to
  attract potential new developers and clients.
  
  .SH OPTIONS
  Options must be given before the list of goals to execute.
  .TP
  \fB\-\-debug\fR (\fB\-X\fR)
  Produce execution debug output
  .TP
  \fB\-\-emacs\fR (\fB\-E\fR)
  Produce logging information without adornments.
  .TP
  \fB\-\-define\fR arg (\fB-D\fRarg)
  Define a system property.
  arg must be in the form: 
  .br
  \fBmaven.property.name\fI=\fRvalue
  .TP
  \fB\-\-nobanner\fR (\fB\-b)
  Suppress the logo banner.
  .TP
  \fB\-\-dir\fR (\fB\-d\fR) arg
  Set the effective working directory.
  .TP
  \fB\-\-exception\fR (\fB\-e\fR)
  Produce exception stack traces.
  .TP
  \fB\-\-find\fR (\fB-f\fR) arg
  Set the project file and effective working directory by finding the project.
  file.
  .TP
  \fB\-\-goals\fR (\fB\-g\fR)
  Display available goals.
  .TP
  \fB\-\-help\fR (\fB\-h\fR)
  Display help information.
  .TP
  \fB\-\-info\fR (\fB\-i\fR)
  Display system information.
  .TP
  \fB\-\-offline\fR (\fB\-o\fR)
  Build is happening offline.
  .TP
  \fB\-\-pom\fR (\fB\-p\fR) arg
  Set the project file.
  .TP
  \fB\-\-version\fR (\fB\-v\fR)
  Display the version of \fBmaven\fR we are using.
  .SH FILES
  .I ./build.properties
  .RS
  Project wide configuration file.
  .RE
  .I ~/build.properties
  .RS
  Per user configuration file.
  .SH ENVIRONMENT
  .IP MAVEN_HOME
  \fBMaven\fR's home directory.
  .br
  .IP MAVEN_REPO
  \fBMaven\fR's local repository.
  .SH BUGS
  Probably. They can be found/added here:
  .br
  \fBhttp://jira.codehaus.org/BrowseProject.jspa?id=10030
  .SH MAILING-LISTS
  \fBUsers\fR:      [EMAIL PROTECTED]
  .br
  \fBDevelopers\fR: [EMAIL PROTECTED]
  .SH AUTHORS
  Juancarlo Anez <[EMAIL PROTECTED]>
  .br
  Stephane Bailliez <[EMAIL PROTECTED]>
  .br
  Jeff Brekke <[EMAIL PROTECTED]>
  .br
  Tom Copeland <[EMAIL PROTECTED]>
  .br
  Eric Dobbs <[EMAIL PROTECTED]>
  .br
  dIon Gillard <[EMAIL PROTECTED]>
  .br
  Pete Kazmier <[EMAIL PROTECTED]>
  .br
  Peter Lynch <[EMAIL PROTECTED]>
  .br
  Glenn McAllister <[EMAIL PROTECTED]>
  .br
  Bob McWhirter <[EMAIL PROTECTED]>
  .br
  Geir Magnusson Jr. <[EMAIL PROTECTED]>
  .br
  Vincent Massol <[EMAIL PROTECTED]>
  .br
  St�phane Mor <[EMAIL PROTECTED]>
  .br
  Kasper Nielsen <[EMAIL PROTECTED]>
  .br
  Daniel Rall <[EMAIL PROTECTED]>
  .br
  Kurt Schrader <[EMAIL PROTECTED]>
  .br
  James Strachan <[EMAIL PROTECTED]>
  .br
  James Taylor <[EMAIL PROTECTED]>
  .br
  Emmanuel Venisse <[EMAIL PROTECTED]>
  .br
  Jason van Zyl <[EMAIL PROTECTED]>
  .br
  Ben Walding <[EMAIL PROTECTED]>
  .SH CVS HEADER
  $Id: maven.1,v 1.1 2003/03/26 10:40:58 smor Exp $
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to