Skip to content

Commit

Permalink
Update man pages for new command line options
Browse files Browse the repository at this point in the history
  • Loading branch information
gfontenot committed Mar 28, 2014
1 parent c6a05f8 commit 7b1dc7f
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 0 deletions.
50 changes: 50 additions & 0 deletions man/liftoff.1
Expand Up @@ -9,6 +9,15 @@
.Nm
.Op Fl -version
.Op Fl -help
.Op Fl -[no-]strict-prompts
.Op Fl -[no-]cocoapods
.Op Fl -[no-]git
.Op Fl -indentation Ar N
.Op Fl -name Ar PROJECT_NAME
.Op Fl -company Ar COMPANY_NAME
.Op Fl -author Ar AUTHOR_NAME
.Op Fl -prefix Ar PREFIX
.Op Fl -identifier Ar IDENTIFIER
.
.Sh DESCRIPTION
.Nm
Expand All @@ -19,6 +28,47 @@ Run the
.Nm
command inside a directory.
.Pp
It supports the following options:

.Bl -tag -width "-i, --identifier IDENTIFIER"
.It Fl v , Fl -version
display the version number and exit
.It Fl h , Fl -help
display a help message and exit
.It Fl -[no-]strict-prompts
enable or disable strict prompts. If this is enabled,
.Nm
will only prompt for values that don't have a default set.
.It Fl -[no-]cocoapods
enable or disable CocoaPods support
.It Fl -[no-]git
enable or disable
.Xr git 1
configuration
.It Fl t , Fl -indentation Ar N
set the indentation width in spaces
.It Fl n , Fl -name Ar PROJECT_NAME
set the project name
.It Fl c , Fl -company Ar COMPANY_NAME
set the company name
.It Fl a , Fl -author Ar AUTHOR_NAME
set the author name. If you don't provide a default here or in the
.Xr liftoffrc 5 ,
.Nm
will generate a default value by looking at the
.Ic gecos
field from
.Xr passwd 5 .
.It Fl p , Fl -prefix Ar PREFIX
set the project's prefix
.It Fl i , Fl -identifier Ar IDENTIFIER
set the company identifier (com.mycompany). If you don't provide a default here
or in the
.Xr liftoffrc 5 ,
.Nm
will generate a default from a normalized version of the company name.
.El
.Pp
If an Xcode project is found inside the current directory,
.Nm
will configure the existing project.
Expand Down
29 changes: 29 additions & 0 deletions man/liftoffrc.5
Expand Up @@ -125,6 +125,35 @@ Note that this does
affect the default templates. If you choose to be incorrect with your
indentation settings, we recommend that you also override the default templates
in order to be consistently wrong.
.It Ic use_cocoapods
type: boolean
.br
default:
.Ic true
.Pp
Generate a template
.Pa Podfile
and run
.Ic pod install
inside the project directory to install a default set of dependencies.
.Pp
The
.Pa Podfile
can be overridden by adding a custom template. If you override this template,
you should probably override the
.Pa UnitTests-Prefix.pch
template as well, since it imports the default pods if this key is enabled.
.It Ic strict_prompts
type: boolean
.br
default:
.Ic false
.Pp
Only prompt for values that don't have a default value.
.Pp
This is useful when combined with command line options to speed up the project
creation process, or when being used in environments where the interactive
prompt can't be used.
.It Ic warnings
type: array
.br
Expand Down

0 comments on commit 7b1dc7f

Please sign in to comment.