Skip to content

Commit

Permalink
Add man page
Browse files Browse the repository at this point in the history
  • Loading branch information
scenee committed May 9, 2018
1 parent cb802d0 commit 807fcdc
Show file tree
Hide file tree
Showing 10 changed files with 696 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,15 @@ build:
test: bats
@PATH="/bin:$$PWD/bats/bin:$$PWD/bin:$$PATH" test/run.sh ${keychain}

.PHONY: version
version:
@PATH="$$PWD/bin:$$PATH" relax --version

.PHONY: bats
bats:
git clone --depth 1 https://github.com/sstephenson/bats.git

.PHONY: man
man:
@pushd share/man/man1 && ronn relax.1.ronn && popd
@pushd share/man/man7 && ronn relax-*.7.ronn && popd
85 changes: 85 additions & 0 deletions share/man/man1/relax.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "RELAX" "1" "May 2018" "" ""
.
.SH "NAME"
\fBrelax\fR \- A lazy release tool for iOS developers
.
.SH "SYNOPSIS"
\fBrelax\fR [\fIoptions\fR\.\.\.] \fIcommands\fR \.\.\.
.
.SH "DESCRIPTION"
Relax is a lazy) release tool for iOS developers who don\'t want to be bothering with codesign and Xcode stuff\. You don\'t just configure \fBscheme\fR and \fBprovisioning_profile\fR to build archive and IPA files, but also tune the build settings and Info\.plist for each distribution\.
.
.P
Relax allows you to:
.
.IP "\(bu" 4
Ease to build & distribute your app for a provisioning profile\.
.
.IP "\(bu" 4
Make your build reproducible in any build machines\.
.
.IP "\(bu" 4
Manage various configurations for each distribution\.
.
.IP "" 0
.
.SH "OPTIONS"
.
.TP
\fB\-\-version\fR
Print the relax version
.
.TP
\fB\-h, \-\-help\fR
Print the synopsis and a list of the most commonly used commands\.
.
.TP
\fB\-v\fR
Run \fBrelax\fR command in verbose mode\.
.
.SH "COMMAND"
.
.TP
\fBhelp\fR
Print a command usage\.
.
.TP
\fBinit\fR
Initialize Relfile for a project\.
.
.TP
\fBdist\fR
Execute \fBarchive\fR and \fBexport\fR commands\.
.
.TP
\fBarchive\fR
Create an archive file for a project with a scheme and a provisioning profile\.
.
.TP
\fBexport\fR
Create an IPA file from an archive file\.
.
.TP
\fBvalidate\fR
Validate an archive file or IPA file\.
.
.TP
\fBresign\fR
Resign an archive file or IPA file\.
.
.TP
\fBprofile\fR
Manage provisioning profiles\. See rekax\-profile(7)\.
.
.TP
\fBkeychain\fR
Manage keychains and certificates\. See relax\-keychain(7)\.
.
.SH "COPYRIGHT"
Relax is Copyright (C) 2017\-present, Shin Yamamoto \fIhttp://scenee\.com/\fR
.
.SH "SEE ALSO"
relax\-profile(7), relax\-keychain(7)
136 changes: 136 additions & 0 deletions share/man/man1/relax.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

66 changes: 66 additions & 0 deletions share/man/man1/relax.1.ronn
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
relax(1) -- A lazy release tool for iOS developers
===========================================================

## SYNOPSIS

`relax` [<options>...] <commands> ...

## DESCRIPTION

Relax is a lazy) release tool for iOS developers who don't want to be bothering with codesign and Xcode stuff.
You don't just configure `scheme` and `provisioning_profile` to build archive and IPA files, but also tune the
build settings and Info.plist for each distribution.

Relax allows you to:

- Ease to build & distribute your app for a provisioning profile.
- Make your build reproducible in any build machines.
- Manage various configurations for each distribution.

## OPTIONS

* `--version`:
Print the relax version

* `-h, --help`:
Print the synopsis and a list of the most commonly used commands.

* `-v`:
Run `relax` command in verbose mode.

## COMMAND

* `help`:
Print a command usage.

* `init`:
Initialize Relfile for a project.

* `dist`:
Execute `archive` and `export` commands.

* `archive`:
Create an archive file for a project with a scheme and a provisioning profile.

* `export`:
Create an IPA file from an archive file.

* `validate`:
Validate an archive file or IPA file.

* `resign`:
Resign an archive file or IPA file.

* `profile`:
Manage provisioning profiles. See rekax-profile(7).

* `keychain`:
Manage keychains and certificates. See relax-keychain(7).

## COPYRIGHT

Relax is Copyright (C) 2017-present, Shin Yamamoto <http://scenee.com/>

## SEE ALSO

relax-profile(7), relax-keychain(7)
57 changes: 57 additions & 0 deletions share/man/man7/relax-keychain.7
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "RELAX\-KEYCHAIN" "7" "May 2018" "" ""
.
.SH "NAME"
\fBrelax\-keychain\fR \- relax keychain module
.
.SH "SYNOPSIS"
\fBrelax keychain\fR \fIcommands\fR \.\.\.
.
.SH "DESCRIPTION"
The relax keychain module has utility commands to manage your keychain from CLI\. It allows you to ease to use features of \fB/usr/bin/security\fR\.
.
.SH "COMMAND"
.
.TP
\fBadd\fR
Add identities and certificates from a p12 file\.
.
.TP
\fBcerts\fR
List valid certificates\.
.
.TP
\fBcreate\fR
Create a custom keychain\.
.
.TP
\fBdelete\fR
Delete a custom keychain\.
.
.TP
\fBinfo\fR
Show information of a p12 file\.
.
.TP
\fBls\fR
List keychains\.
.
.TP
\fBreset\fR
Reset the default keychain to login\.keychain\.
.
.TP
\fBrm\fR
Remove identities and certificates of a p12 file\.
.
.TP
\fBuse\fR
Set a keychain as the default keychain\.
.
.SH "COPYRIGHT"
Relax is Copyright (C) 2017\-present, Shin Yamamoto \fIhttp://scenee\.com/\fR
.
.SH "SEE ALSO"
relax(1), relax\-profile(7)
Loading

0 comments on commit 807fcdc

Please sign in to comment.