Skip to content

Commit

Permalink
add generated ROFF files to git, for convenience
Browse files Browse the repository at this point in the history
  • Loading branch information
scribu committed May 2, 2012
1 parent ea746df commit 88dbebf
Show file tree
Hide file tree
Showing 41 changed files with 1,073 additions and 1 deletion.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
/.build
/dist
/man
43 changes: 43 additions & 0 deletions man/blog-create.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-BLOG\-CREATE" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-blog\-create\fR \- Create a new blog in a multisite install\.
.
.SH "SYNOPSIS"
\fBwp blog create\fR \-\-slug=\fIslug\fR \-\-title=\fITitle\fR [\-\-email=\fIemail\fR] [\-\-site_id=\fIsite\-id\fR] [\-\-public=true]
.
.SH "OPTIONS"
.
.TP
\fB\-\-slug\fR=\fIslug\fR:
.
.IP
Base for the new domain\. Subdomain on subdomain installs, directory on subdirectory installs\.
.
.TP
\fB\-\-title\fR=<title>:
.
.IP
Title of the new blog\.
.
.TP
\fB\-\-email\fR=\fIemail\fR:
.
.IP
Email for Admin user\. User will be created if none exists\. Assignement to Super Admin if not included\.
.
.TP
\fB\-\-site_id\fR=\fIsite\-id\fR:
.
.IP
Site (network) to associate new blog with\. Defaults to current site (typically 1)\.
.
.TP
\fB\-\-private\fR:
.
.IP
If set, the new blog will be non\-public (not indexed)

43 changes: 43 additions & 0 deletions man/core-config.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-CORE\-CONFIG" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-core\-config\fR \- Create a wp\-config\.php file\.
.
.SH "SYNOPSIS"
\fBwp core config\fR \-\-dbname=\fIname\fR \-\-dbuser=\fIuser\fR \-\-dbpass=\fIpassword\fR [\-\-dbhost=localhost] [\-\-dbprefix=wp_]
.
.SH "OPTIONS"
.
.TP
\fB\-\-dbname\fR=\fIdbname\fR:
.
.IP
Set the database name\.
.
.TP
\fB\-\-dbuser\fR=\fIdbuser\fR:
.
.IP
Set the database user\.
.
.TP
\fB\-\-dbpass\fR=\fIdbpass\fR:
.
.IP
Set the database user password\.
.
.TP
\fB\-\-dbhost\fR=\fIdbhost\fR:
.
.IP
Set the database host\. Default: \'localhost\'
.
.TP
\fB\-\-dbprefix\fR=\fIdbprefix\fR:
.
.IP
Set the database table prefix\. Default: \'wp_\'

27 changes: 27 additions & 0 deletions man/core-download.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-CORE\-DOWNLOAD" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-core\-download\fR \- Download core WordPress files\.
.
.SH "SYNOPSIS"
\fBwp core download\fR [\-\-version=\fIversion\fR]
.
.SH "OPTIONS"
.
.TP
\fB\-\-version\fR=\fIversion\fR:
.
.IP
Select which version you want to download\.
.
.SH "EXAMPLES"
.
.nf

Download version 3\.3: wp core download \-\-version=3\.3
.
.fi

43 changes: 43 additions & 0 deletions man/core-install.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-CORE\-INSTALL" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-core\-install\fR \- Install the WordPress tables in the database\.
.
.SH "SYNOPSIS"
\fBwp core install\fR \-\-site_url=\fIurl\fR \-\-site_title=\fItitle> [\-\-admin_name=<username\fR] \-\-admin_password=\fIpassword\fR \-\-admin_email=\fIemail\fR
.
.SH "OPTIONS"
.
.TP
\fB\-\-site_url\fR=\fIurl\fR:
.
.IP
The address of the new site\.
.
.TP
\fB\-\-site_title\fR=<title>:
.
.IP
The title of the new site\.
.
.TP
\fB\-\-admin_name\fR=\fIusername\fR:
.
.IP
The name of the admin user\. Default: \'admin\'
.
.TP
\fB\-\-admin_password\fR=\fIpassword\fR:
.
.IP
The password for the admin user\.
.
.TP
\fB\-\-admin_email\fR=\fIemail\fR:
.
.IP
The email address for the admin user\.

10 changes: 10 additions & 0 deletions man/core-update.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-CORE\-UPDATE" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-core\-update\fR \- Update WordPress to the latest version\.
.
.SH "SYNOPSIS"
\fBwp core update\fR
19 changes: 19 additions & 0 deletions man/core-version.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-CORE\-VERSION" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-core\-version\fR \- Show the WordPress version\.
.
.SH "SYNOPSIS"
\fBwp core version\fR [\-\-extra]
.
.SH "OPTIONS"
.
.TP
\fB\-\-extra\fR:
.
.IP
Show extended version information\.

10 changes: 10 additions & 0 deletions man/db-cli.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-DB\-CLI" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-db\-cli\fR \- Open a SQL command\-line interface to the WordPress database\.
.
.SH "SYNOPSIS"
\fBwp db cli\fR
10 changes: 10 additions & 0 deletions man/db-connect.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-DB\-CONNECT" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-db\-connect\fR \- Print a string for connecting to the database\.
.
.SH "SYNOPSIS"
\fBwp db connect\fR
10 changes: 10 additions & 0 deletions man/db-create.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-DB\-CREATE" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-db\-create\fR \- Create a database using the credentials from wp\-config\.php\.
.
.SH "SYNOPSIS"
\fBwp db create\fR
19 changes: 19 additions & 0 deletions man/db-export.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-DB\-EXPORT" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-db\-export\fR \- Export the WordPress database using mysqldump\.
.
.SH "SYNOPSIS"
\fBwp db export\fR [\fIfile\fR]
.
.SH "OPTIONS"
.
.TP
\fB<file>\fR:
.
.IP
The name of the export file\. If omitted, it will be \'{dbname}\.sql\'

19 changes: 19 additions & 0 deletions man/db-import.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-DB\-IMPORT" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-db\-import\fR \- Import a database from a text file\.
.
.SH "SYNOPSIS"
\fBwp db import\fR [\fIfile\fR]
.
.SH "OPTIONS"
.
.TP
\fB<file>\fR:
.
.IP
The name of the import file\. If omitted, it will be \'{dbname}\.sql\'

19 changes: 19 additions & 0 deletions man/db-query.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-DB\-QUERY" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-db\-query\fR \- Execute a query against the WordPress database\.
.
.SH "SYNOPSIS"
\fBwp db query\fR \fISQL\fR
.
.SH "OPTIONS"
.
.TP
\fB<SQL>\fR:
.
.IP
A SQL query\.

19 changes: 19 additions & 0 deletions man/eval-file.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-EVAL\-FILE" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-eval\-file\fR \- Loads and executes a PHP file after loading WordPress\.
.
.SH "SYNOPSIS"
\fBwp eval\-file\fR \fIfile\fR
.
.SH "EXAMPLES"
.
.nf

wp eval\-file my\-code\.php
.
.fi

19 changes: 19 additions & 0 deletions man/eval.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-EVAL" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-eval\fR \- Executes arbitrary PHP code after loading WordPress\.
.
.SH "SYNOPSIS"
\fBwp eval\fR \fIPHP\fR
.
.SH "EXAMPLES"
.
.nf

wp eval \'echo WP_CONTENT_DIR;\'
.
.fi

71 changes: 71 additions & 0 deletions man/export.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WP\-EXPORT" "1" "May 2012" "" "WP-CLI"
.
.SH "NAME"
\fBwp\-export\fR \- Create a WXR file\.
.
.SH "SYNOPSIS"
\fBwp export\fR \-\-path=\fIdirname\fR [filters] [\-\-skip_comments]
.
.SH "OPTIONS"
.
.TP
\fB\-\-path\fR=\fIdirname\fR:
.
.IP
Full Path to directory where WXR export files should be stored\.
.
.TP
\fB\-\-skip_comments\fR:
.
.IP
Don\'t export comments\.
.
.SH "FILTERS"
.
.TP
\fB\-\-start_date\fR=\fIdate\fR:
.
.IP
Export only posts newer than this date in format YYYY\-MM\-DD\.
.
.TP
\fB\-\-end_date\fR=\fIdate\fR:
.
.IP
Export only posts older than this date in format YYYY\-MM\-DD\.
.
.TP
\fB\-\-post_type\fR=\fIpost_type\fR:
.
.IP
Export only posts with this post_type\.
.
.TP
\fB\-\-author\fR=<login/id>:
.
.IP
Export only posts by this author\.
.
.TP
\fB\-\-category\fR=\fIcategory\-id\fR:
.
.IP
Export only posts in this category\.
.
.TP
\fB\-\-post_status\fR=\fIstatus\fR:
.
.IP
Export only posts with this status\.
.
.SH "EXAMPLES"
.
.nf

wp export \-\-path=/tmp/ \-\-user=admin \-\-post_type=post \-\-start_date=2011\-01\-01 \-\-end_date=2011\-12\-31
.
.fi

Loading

0 comments on commit 88dbebf

Please sign in to comment.