diff --git a/.travis.yml b/.travis.yml index 138b44b662..cff1fea328 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,12 +6,12 @@ php: env: - WP_VERSION=latest - - WP_VERSION=3.4.2 WITH_RONN=1 + - WP_VERSION=3.4.2 matrix: exclude: - php: 5.4 - env: WP_VERSION=3.4.2 WITH_RONN=1 + env: WP_VERSION=3.4.2 before_script: ./bin/ci/install_dependencies.sh diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52ce37fda4..3580119b93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,17 +15,6 @@ Also, please create or update the appropriate `.txt` file in the `man-src` direc Lastly, please follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/). -Generating man pages --------------------- - -To generate a man page, WP-CLI looks for `.txt` files in the `man-src` directory. It also gathers information from the inline comments and the `@synopsis` annotations. - -The compiled man page is placed in the `man` directory. - -To (re)generate one or more man pages, you first need to have the [ronn](https://rubygems.org/gems/ronn) ruby gem installed. - -Then, you can use the `wp help --gen` command. - Running the tests ----------------- diff --git a/bin/ci/install_dependencies.sh b/bin/ci/install_dependencies.sh index 02b33c11b9..c756510987 100755 --- a/bin/ci/install_dependencies.sh +++ b/bin/ci/install_dependencies.sh @@ -8,10 +8,6 @@ set -ex composer install --dev --no-interaction --prefer-source composer require d11wtq/boris=dev-master --no-interaction --prefer-source -if [ -n "$WITH_RONN" ]; then - gem install ronn -fi - # set up WP install ./bin/wp core download --version=$WP_VERSION --path=/tmp/wp-cli-test-core-download-cache/ diff --git a/bin/ci/run_build.sh b/bin/ci/run_build.sh index aed4ad0bf3..3ed2e35cdb 100755 --- a/bin/ci/run_build.sh +++ b/bin/ci/run_build.sh @@ -4,8 +4,4 @@ set -ex vendor/bin/phpunit -if [ -z "$WITH_RONN" ]; then - BEHAT_OPTS="--tags ~@ronn" -fi - -vendor/bin/behat --format progress $BEHAT_OPTS +vendor/bin/behat --format progress diff --git a/features/help.feature b/features/help.feature index 5b8b421fe1..2f2193548c 100644 --- a/features/help.feature +++ b/features/help.feature @@ -4,52 +4,21 @@ Feature: Get help about WP-CLI commands Given an empty directory When I run `wp help` - Then STDOUT should contain: - """ - Available commands: - """ + Then STDOUT should not be empty When I run `wp help core` - Then STDOUT should contain: - """ - usage: wp core - """ + Then STDOUT should not be empty When I run `wp help core download` - Then STDOUT should contain: - """ - WP-CORE-DOWNLOAD(1) - """ + Then STDOUT should not be empty - When I run `wp help --help` - Then STDOUT should contain: - """ - WP-HELP(1) - """ + When I run `wp help help` + Then STDOUT should not be empty When I try `wp help non-existent-command` Then the return code should be 1 And STDERR should not be empty - @ronn - Scenario: Generating help for subcommands - Given an empty directory - When I run `wp help --gen option` - Then STDOUT should be: - """ - generated option.1 - """ - - @ronn - Scenario: Generating help for multisite-only subcommands - Given an empty directory - When I run `wp help --gen site create` - Then STDOUT should be: - """ - generated site-create.1 - """ - - @ronn Scenario: Help for third-party commands Given a WP install And a wp-content/plugins/test-cli/test-help.txt file: @@ -76,17 +45,5 @@ Feature: Get help about WP-CLI commands When I run `wp help test-help` Then STDOUT should contain: """ - usage: wp test-help - """ - - When I run `wp help --gen test-help` - Then STDOUT should contain: - """ - generated test-help.1 - """ - - When I run `wp help test-help` - Then STDOUT should contain: - """ - WP-TEST-HELP(1) + wp test-help """ diff --git a/man-src/help.txt b/man-src/help.txt index 69ac8e6993..19e660f7c4 100644 --- a/man-src/help.txt +++ b/man-src/help.txt @@ -1,10 +1,7 @@ ## EXAMPLES - # (re)generates all man pages - wp help --gen + # get help for `core` command + wp help core - # (re)generate man pages for the `core` command - wp help --gen core - - # (re)generate man page only for the `core download` subcommand - wp help --gen core download + # get help for `core download` subcommand + wp help core download diff --git a/man/cache.1 b/man/cache.1 deleted file mode 100644 index 7587a2a941..0000000000 --- a/man/cache.1 +++ /dev/null @@ -1,101 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CACHE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-cache\fR \- Manage the object cache\. -. -.SH "SYNOPSIS" -wp cache add \fIkey\fR \fIvalue\fR [\fIgroup\fR] [\fIexpiration\fR] -. -.P -wp cache decr \fIkey\fR [\fIoffset\fR] [\fIgroup\fR] -. -.P -wp cache delete \fIkey\fR [\fIgroup\fR] -. -.P -wp cache flush -. -.P -wp cache get \fIkey\fR [\fIgroup\fR] -. -.P -wp cache incr \fIkey\fR [\fIoffset\fR] [\fIgroup\fR] -. -.P -wp cache replace \fIkey\fR \fIvalue\fR [\fIgroup\fR] [\fIexpiration\fR] -. -.P -wp cache set \fIkey\fR \fIvalue\fR [\fIgroup\fR] [\fIexpiration\fR] -. -.P -wp cache type -. -.SH "SUBCOMMANDS" -. -.TP -\fBadd\fR: -. -.IP -Add a value to the object cache\. -. -.TP -\fBdecr\fR: -. -.IP -Decrement a value in the object cache\. -. -.TP -\fBdelete\fR: -. -.IP -Remove a value from the object cache\. -. -.TP -\fBflush\fR: -. -.IP -Flush the object cache\. -. -.TP -\fBget\fR: -. -.IP -Get a value from the object cache\. -. -.TP -\fBincr\fR: -. -.IP -Increment a value in the object cache\. -. -.TP -\fBreplace\fR: -. -.IP -Replace an existing value in the object cache\. -. -.TP -\fBset\fR: -. -.IP -Set a value to the object cache\. -. -.TP -\fBtype\fR: -. -.IP -Attempts to determine which object cache is being used\. -. -.SH "EXAMPLES" -. -.nf - -wp cache set my_key my_value my_group 300 - -wp cache get my_key my_group -. -.fi - diff --git a/man/cap.1 b/man/cap.1 deleted file mode 100644 index fd4b8f669a..0000000000 --- a/man/cap.1 +++ /dev/null @@ -1,52 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CAP" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-cap\fR \- Manage user capabilities\. -. -.SH "SYNOPSIS" -wp cap add \fIrole\fR \fIcap\fR\.\.\. -. -.P -wp cap list \fIrole\fR -. -.P -wp cap remove \fIrole\fR \fIcap\fR\.\.\. -. -.SH "SUBCOMMANDS" -. -.TP -\fBadd\fR: -. -.IP -Add capabilities to a given role\. -. -.TP -\fBlist\fR: -. -.IP -List capabilities for a given role\. -. -.TP -\fBremove\fR: -. -.IP -Remove capabilities from a given role\. -. -.SH "EXAMPLES" -. -.nf - -# Add \'spectate\' capability to \'author\' role -wp cap add \'author\' \'spectate\' - -# Add all caps from \'editor\' role to \'author\' role -wp cap list \'editor\' | xargs wp cap add \'author\' - -# Remove all caps from \'editor\' role that also appear in \'author\' role -wp cap list \'author\' | xargs wp cap remove \'editor\' -. -.fi - diff --git a/man/comment-approve.1 b/man/comment-approve.1 deleted file mode 100644 index 759498b75c..0000000000 --- a/man/comment-approve.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-APPROVE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-approve\fR \- Approve a comment\. -. -.SH "SYNOPSIS" -wp comment approve \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to approve\. -. -.SH "EXAMPLES" -. -.nf - -wp comment approve 1337 -. -.fi - diff --git a/man/comment-count.1 b/man/comment-count.1 deleted file mode 100644 index 4cb5c913b5..0000000000 --- a/man/comment-count.1 +++ /dev/null @@ -1,28 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-COUNT" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-count\fR \- Count comments, on whole blog or on a given post\. -. -.SH "SYNOPSIS" -wp comment count [\fIpost\-id\fR] -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the post to count comments in -. -.SH "EXAMPLES" -. -.nf - -wp comment count -wp comment count 42 -. -.fi - diff --git a/man/comment-create.1 b/man/comment-create.1 deleted file mode 100644 index 8ca70f0cec..0000000000 --- a/man/comment-create.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-CREATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-create\fR \- Insert a comment\. -. -.SH "SYNOPSIS" -wp comment create \-\-\fIfield\fR=\fIvalue\fR [\-\-porcelain] -. -.SH "OPTIONS" -. -.TP -\fB\-\-\fR=\fIvalue\fR: -. -.IP -Field values for the new comment\. See wp_insert_comment()\. -. -.TP -\fB\-\-porcelain\fR: -. -.IP -Output just the new comment id\. -. -.SH "EXAMPLES" -. -.nf - -wp comment create \-\-comment_post_ID=15 \-\-comment_content="hello blog" -. -.fi -. -.P -\-\-comment_author="wp\-cli" diff --git a/man/comment-delete.1 b/man/comment-delete.1 deleted file mode 100644 index fe9567b793..0000000000 --- a/man/comment-delete.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-delete\fR \- Delete a comment\. -. -.SH "SYNOPSIS" -wp comment delete \fIid\fR [\-\-force] -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to delete\. -. -.TP -\fB\-\-force\fR: -. -.IP -Skip the trash bin\. -. -.SH "EXAMPLES" -. -.nf - -wp comment delete 1337 \-\-force -. -.fi - diff --git a/man/comment-last.1 b/man/comment-last.1 deleted file mode 100644 index 47b760f839..0000000000 --- a/man/comment-last.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-LAST" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-last\fR \- Get last approved comment\. -. -.SH "SYNOPSIS" -wp comment last [\-\-id] [\-\-full] -. -.SH "OPTIONS" -. -.TP -\fB\-\-id\fR: -. -.IP -Output just the last comment id\. -. -.TP -\fB\-\-full\fR: -. -.IP -Output complete comment information\. -. -.SH "EXAMPLES" -. -.nf - -wp comment last \-\-full -. -.fi - diff --git a/man/comment-spam.1 b/man/comment-spam.1 deleted file mode 100644 index 1f07321783..0000000000 --- a/man/comment-spam.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-SPAM" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-spam\fR \- Spam a comment\. -. -.SH "SYNOPSIS" -wp comment spam \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to mark as spam\. -. -.SH "EXAMPLES" -. -.nf - -wp comment spam 1337 -. -.fi - diff --git a/man/comment-status.1 b/man/comment-status.1 deleted file mode 100644 index 70c4ddd4ef..0000000000 --- a/man/comment-status.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-STATUS" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-status\fR \- Get status of a comment\. -. -.SH "SYNOPSIS" -wp comment status \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to check -. -.SH "EXAMPLES" -. -.nf - -wp comment status 1337 -. -.fi - diff --git a/man/comment-trash.1 b/man/comment-trash.1 deleted file mode 100644 index 2deba83bae..0000000000 --- a/man/comment-trash.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-TRASH" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-trash\fR \- Trash a comment\. -. -.SH "SYNOPSIS" -wp comment trash \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to trash\. -. -.SH "EXAMPLES" -. -.nf - -wp comment trash 1337 -. -.fi - diff --git a/man/comment-unapprove.1 b/man/comment-unapprove.1 deleted file mode 100644 index e6d18d043f..0000000000 --- a/man/comment-unapprove.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-UNAPPROVE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-unapprove\fR \- Unapprove a comment\. -. -.SH "SYNOPSIS" -wp comment unapprove \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to unapprove\. -. -.SH "EXAMPLES" -. -.nf - -wp comment unapprove 1337 -. -.fi - diff --git a/man/comment-unspam.1 b/man/comment-unspam.1 deleted file mode 100644 index 41d7dd87f0..0000000000 --- a/man/comment-unspam.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-UNSPAM" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-unspam\fR \- Unspam a comment\. -. -.SH "SYNOPSIS" -wp comment unspam \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to unmark as spam\. -. -.SH "EXAMPLES" -. -.nf - -wp comment unspam 1337 -. -.fi - diff --git a/man/comment-untrash.1 b/man/comment-untrash.1 deleted file mode 100644 index ca2caa724c..0000000000 --- a/man/comment-untrash.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-COMMENT\-UNTRASH" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-comment\-untrash\fR \- Untrash a comment\. -. -.SH "SYNOPSIS" -wp comment untrash \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB\fR: -. -.IP -The ID of the comment to untrash\. -. -.SH "EXAMPLES" -. -.nf - -wp comment untrash 1337 -. -.fi - diff --git a/man/core-config.1 b/man/core-config.1 deleted file mode 100644 index 4a8d6e8d91..0000000000 --- a/man/core-config.1 +++ /dev/null @@ -1,64 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CORE\-CONFIG" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-core\-config\fR \- Set up a wp\-config\.php file\. -. -.SH "SYNOPSIS" -wp core config \-\-dbname=\fIname\fR \-\-dbuser=\fIuser\fR [\-\-dbpass=\fIpassword\fR] [\-\-dbhost=\fIhost\fR] [\-\-dbprefix=\fIprefix\fR] [\-\-extra\-php] -. -.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_\' -. -.TP -\fB\-\-extra\-php\fR: -. -.IP -If set, the command reads additional PHP code from STDIN\. -. -.SH "EXAMPLES" -. -.nf - -# Standard wp\-config\.php file -wp core config \-\-dbname=testing \-\-dbuser=wp \-\-dbpass=securepswd - -# Enable WP_DEBUG and WP_DEBUG_LOG -wp core config \-\-dbname=testing \-\-dbuser=wp \-\-dbpass=securepswd \-\-extra\-php <\fR: -. -.IP -The directory in which to download the testing suite files\. (Optional) -. -.TP -\fB\-\-dbname\fR=\fIdbname\fR: -. -.IP -Set the database name\. \fBWARNING\fR: The database will be whipped every time you run the tests\. -. -.TP -\fB\-\-dbuser\fR=\fIdbuser\fR: -. -.IP -Set the database user\. -. -.TP -\fB\-\-dbpass\fR=\fIdbpass\fR: -. -.IP -Set the database user password\. -. -.SH "EXAMPLE" -. -.nf - -wp core init\-tests ~/svn/wp\-tests \-\-dbname=wp_test \-\-dbuser=wp_test -. -.fi - diff --git a/man/core-install-network.1 b/man/core-install-network.1 deleted file mode 100644 index 60fdbfc0e7..0000000000 --- a/man/core-install-network.1 +++ /dev/null @@ -1,31 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CORE\-INSTALL\-NETWORK" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-core\-install\-network\fR \- Transform a single\-site install into a multi\-site install\. -. -.SH "SYNOPSIS" -wp core install\-network \-\-title=\fInetwork\-title\fR [\-\-base=\fIurl\-path\fR] [\-\-subdomains] -. -.SH "OPTIONS" -. -.TP -\fB\-\-title\fR=\fIsite\-title\fR: -. -.IP -The title of the new network\. -. -.TP -\fB\-\-base\fR=\fIurl\-path\fR: -. -.IP -Base path after the domain name that each site url will start with\. Default: \'/\' -. -.TP -\fB\-\-subdomains\fR: -. -.IP -If passed, the network will use subdomains, instead of subdirectories\. - diff --git a/man/core-install.1 b/man/core-install.1 deleted file mode 100644 index 8667886296..0000000000 --- a/man/core-install.1 +++ /dev/null @@ -1,43 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CORE\-INSTALL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-core\-install\fR \- Create the WordPress tables in the database\. -. -.SH "SYNOPSIS" -wp core install \-\-url=\fIurl\fR \-\-title=\fIsite\-title\fR [\-\-admin_name=\fIusername\fR] \-\-admin_email=\fIemail\fR \-\-admin_password=\fIpassword\fR -. -.SH "OPTIONS" -. -.TP -\fB\-\-url\fR=\fIurl\fR: -. -.IP -The address of the new site\. -. -.TP -\fB\-\-title\fR=\fIsite\-title\fR: -. -.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\. - diff --git a/man/core-is-installed.1 b/man/core-is-installed.1 deleted file mode 100644 index 56f61768b5..0000000000 --- a/man/core-is-installed.1 +++ /dev/null @@ -1,21 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CORE\-IS\-INSTALLED" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-core\-is\-installed\fR \- Determine if the WordPress tables are installed\. -. -.SH "SYNOPSIS" -wp core is\-installed -. -.SH "EXAMPLES" -. -.nf - -if ! $(wp core is\-installed); then - wp core install -fi -. -.fi - diff --git a/man/core-update-db.1 b/man/core-update-db.1 deleted file mode 100644 index 1dd86294fd..0000000000 --- a/man/core-update-db.1 +++ /dev/null @@ -1,10 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CORE\-UPDATE\-DB" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-core\-update\-db\fR \- Update the WordPress database\. -. -.SH "SYNOPSIS" -wp core update\-db diff --git a/man/core-update.1 b/man/core-update.1 deleted file mode 100644 index cb5848fb20..0000000000 --- a/man/core-update.1 +++ /dev/null @@ -1,37 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CORE\-UPDATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-core\-update\fR \- Update WordPress\. -. -.SH "SYNOPSIS" -wp core update [\fIzip\fR] [\-\-version=\fIversion\fR] [\-\-force] -. -.SH "OPTIONS" -. -.TP -\fB\-\-version=\fR\fInew_version\fR [package/zip]: -. -.IP -When passed, updates to new_version, optionally using package/zip as input\. -. -.TP -\fB\-\-force\fR: -. -.IP -Will update even when current WP version < passed version\. Use with caution\. -. -.SH "EXAMPLES" -. -.nf - -wp core update - -wp core update \-\-version=3\.4 \.\./latest\.zip - -wp core update \-\-version=3\.1 \-\-force -. -.fi - diff --git a/man/core-version.1 b/man/core-version.1 deleted file mode 100644 index c3a37f1c15..0000000000 --- a/man/core-version.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-CORE\-VERSION" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-core\-version\fR \- Display the WordPress version\. -. -.SH "SYNOPSIS" -wp core version [\-\-extra] -. -.SH "OPTIONS" -. -.TP -\fB\-\-extra\fR: -. -.IP -Show extended version information\. - diff --git a/man/db.1 b/man/db.1 deleted file mode 100644 index 7524abedd3..0000000000 --- a/man/db.1 +++ /dev/null @@ -1,120 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-DB" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-db\fR \- Perform basic database operations\. -. -.SH "SYNOPSIS" -wp db cli -. -.P -wp db create -. -.P -wp db drop [\-\-yes] -. -.P -wp db export [\fIfile\fR] -. -.P -wp db import [\fIfile\fR] -. -.P -wp db optimize -. -.P -wp db query [\fIsql\fR] -. -.P -wp db repair -. -.P -wp db reset [\-\-yes] -. -.SH "SUBCOMMANDS" -. -.TP -\fBcli\fR: -. -.IP -Open a mysql console using the WordPress credentials\. -. -.TP -\fBcreate\fR: -. -.IP -Create the database, as specified in wp\-config\.php -. -.TP -\fBdrop\fR: -. -.IP -Delete the database\. -. -.TP -\fBexport\fR: -. -.IP -Exports the database using mysqldump\. -. -.TP -\fBimport\fR: -. -.IP -Import database from a file\. -. -.TP -\fBoptimize\fR: -. -.IP -Optimize the database\. -. -.TP -\fBquery\fR: -. -.IP -Execute a query against the database\. -. -.TP -\fBrepair\fR: -. -.IP -Repair the database\. -. -.TP -\fBreset\fR: -. -.IP -Remove all tables from the database\. -. -.SH "OPTIONS" -. -.TP -\fB\-\-yes\fR: -. -.IP -Answer yes to the confirmation message\. -. -.TP -\fB\fR: -. -.IP -The name of the export file\. If omitted, it will be \'{dbname}\.sql\' -. -.TP -\fB\fR: -. -.IP -A SQL query\. -. -.SH "EXAMPLES" -. -.nf - -# execute a query stored in a file -wp db query < debug\.sql -. -.fi - diff --git a/man/eval-file.1 b/man/eval-file.1 deleted file mode 100644 index fc8fb2cafd..0000000000 --- a/man/eval-file.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-EVAL\-FILE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-eval\-file\fR \- Load and execute a PHP file after loading WordPress\. -. -.SH "SYNOPSIS" -wp eval\-file \fIpath\fR -. -.SH "EXAMPLES" -. -.nf - -wp eval\-file my\-code\.php -. -.fi - diff --git a/man/eval.1 b/man/eval.1 deleted file mode 100644 index 644451e322..0000000000 --- a/man/eval.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-EVAL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-eval\fR \- Execute arbitrary PHP code after loading WordPress\. -. -.SH "SYNOPSIS" -wp eval \fIphp\-code\fR -. -.SH "EXAMPLES" -. -.nf - -wp eval \'echo WP_CONTENT_DIR;\' -. -.fi - diff --git a/man/export.1 b/man/export.1 deleted file mode 100644 index e4aaf633b0..0000000000 --- a/man/export.1 +++ /dev/null @@ -1,91 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-EXPORT" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-export\fR \- Export content to a WXR file\. -. -.SH "SYNOPSIS" -wp export [\-\-dir=\fIdir\fR] [\-\-start_date=\fIdate\fR] [\-\-end_date=\fIdate\fR] [\-\-post_type=\fIptype\fR] [\-\-post_status=\fIstatus\fR] [\-\-post__in=\fIpids\fR] [\-\-author=\fIlogin\fR] [\-\-category=\fIcat\fR] [\-\-skip_comments] [\-\-file_item_count=\fIcount\fR] [\-\-verbose] -. -.SH "OPTIONS" -. -.TP -\fB\-\-dir\fR=\fIdirname\fR: -. -.IP -Full path to directory where WXR export files should be stored\. Defaults to current working directory\. -. -.TP -\fB\-\-skip_comments\fR: -. -.IP -Don\'t export comments\. -. -.TP -\fB\-\-file_item_count\fR=\fIcount\fR: -. -.IP -Break export into files with N posts\. -. -.TP -\fB\-\-verbose\fR: -. -.IP -Show more information about the process on STDOUT\. -. -.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\-\-post__in\fR=\fIpid\fR: -. -.IP -Export all posts specified as a comma\-separated list of IDs\. -. -.TP -\fB\-\-author\fR=: -. -.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 \-\-dir=/tmp/ \-\-user=admin \-\-post_type=post \-\-start_date=2011\-01\-01 \-\-end_date=2011\-12\-31 - -wp export \-\-dir=/tmp/ \-\-post__in=123,124,125 -. -.fi - diff --git a/man/help.1 b/man/help.1 deleted file mode 100644 index 9b707455e8..0000000000 --- a/man/help.1 +++ /dev/null @@ -1,26 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-HELP" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-help\fR \- Get help on a certain topic\. -. -.SH "SYNOPSIS" -wp help [\fIcommand\fR] [\-\-gen] -. -.SH "EXAMPLES" -. -.nf - -# (re)generates all man pages -wp help \-\-gen - -# (re)generate man pages for the `core` command -wp help \-\-gen core - -# (re)generate man page only for the `core download` subcommand -wp help \-\-gen core download -. -.fi - diff --git a/man/media-import.1 b/man/media-import.1 deleted file mode 100644 index 8ef92207d1..0000000000 --- a/man/media-import.1 +++ /dev/null @@ -1,72 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-MEDIA\-IMPORT" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-media\-import\fR \- Create attachments from local files or from URLs\. -. -.SH "SYNOPSIS" -wp media import \fIfile\fR\.\.\. [\-\-post_id=\fIid\fR] [\-\-title=\fItitle\fR] [\-\-caption=\fIcaption\fR] [\-\-alt=\fItext\fR] [\-\-desc=\fIdescription\fR] [\-\-featured_image] -. -.SH "OPTIONS" -. -.IP "\(bu" 4 -\fB\fR: -. -.IP -Path to file or files to be imported\. Supports the glob(3) capabilities of the current shell\. If file is recognized as a URL (for example, with a scheme of http or ftp), the file will be downloaded to a temp file before being sideloaded\. -. -.IP "\(bu" 4 -\fB\-\-post_id=\fR -. -.IP -ID of the post to attach the imported files to -. -.IP "\(bu" 4 -\fB\-\-title=\fR -. -.IP -Attachment title (post title field) -. -.IP "\(bu" 4 -\fB\-\-caption=<caption>\fR -. -.IP -Caption for attachent (post excerpt field) -. -.IP "\(bu" 4 -\fB\-\-alt=<alt_text>\fR -. -.IP -Alt text for image (saved as post meta) -. -.IP "\(bu" 4 -\fB\-\-desc=<description>\fR -. -.IP -"Description" field (post content) of attachment post -. -.IP "\(bu" 4 -\fB\-\-featured_image\fR -. -.IP -If set, set the imported image as the Featured Image of the post its attached to\. -. -.IP "" 0 -. -.SH "EXAMPLES" -. -.nf - -# Import all jpgs in the current user\'s "Pictures" directory, not attached to any post -wp media import ~/Pictures/**/*\.jpg - -# Import a local image and set it to be the post thumbnail for a post -wp media import ~/Downloads/image\.png \-\-post_id=123 \-\-title="A downloaded picture" \-\-featured_image - -# Import an image from the web -wp media import http://s\.wordpress\.org/style/images/wp\-header\-logo\.png \-\-title=\'The WordPress logo\' \-\-alt="Semantic personal publishing" -. -.fi - diff --git a/man/media-regenerate.1 b/man/media-regenerate.1 deleted file mode 100644 index c829722ac0..0000000000 --- a/man/media-regenerate.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-MEDIA\-REGENERATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-media\-regenerate\fR \- Regenerate thumbnail(s)\. -. -.SH "SYNOPSIS" -wp media regenerate \fIattachment\-id\fR\.\.\. [\-\-yes] -. -.SH "OPTIONS" -. -.TP -\fB\-\-yes\fR: -. -.IP -Answer yes to the confirmation message\. -. -.TP -\fB<attachment\-id>\fR: -. -.IP -One or more IDs of the attachments to regenerate\. -. -.SH "EXAMPLES" -. -.nf - -wp media regenerate 123 1337 - -wp media regenerate \-\-yes -. -.fi - diff --git a/man/network-meta.1 b/man/network-meta.1 deleted file mode 100644 index 0beb7eb4a8..0000000000 --- a/man/network-meta.1 +++ /dev/null @@ -1,69 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-NETWORK\-META" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-network\-meta\fR \- Manage network custom fields\. -. -.SH "SYNOPSIS" -wp network\-meta add \fIid\fR \fIkey\fR \fIvalue\fR [\-\-format=\fIformat\fR] -. -.P -wp network\-meta delete \fIid\fR \fIkey\fR -. -.P -wp network\-meta get \fIid\fR \fIkey\fR [\-\-format=\fIformat\fR] -. -.P -wp network\-meta update \fIid\fR \fIkey\fR \fIvalue\fR [\-\-format=\fIformat\fR] -. -.SH "SUBCOMMANDS" -. -.TP -\fBadd\fR: -. -.IP -Add a meta field\. -. -.TP -\fBdelete\fR: -. -.IP -Delete a meta field\. -. -.TP -\fBget\fR: -. -.IP -Get meta field value\. -. -.TP -\fBupdate\fR: -. -.IP -Update a meta field\. -. -.SH "OPTIONS" -. -.TP -\fB<id>\fR: -. -.IP -The network id (usually 1)\. -. -.TP -\fB\-\-format=json\fR: -. -.IP -Encode/decode values as JSON\. -. -.SH "EXAMPLES" -. -.nf - -# get a list of super\-admins -wp network\-meta get 1 site_admins -. -.fi - diff --git a/man/option.1 b/man/option.1 deleted file mode 100644 index 69a8fb23b6..0000000000 --- a/man/option.1 +++ /dev/null @@ -1,68 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-OPTION" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-option\fR \- Manage WordPress options\. -. -.SH "SYNOPSIS" -wp option add \fIkey\fR [\-\-format=\fIformat\fR] -. -.P -wp option delete \fIkey\fR -. -.P -wp option get \fIkey\fR [\-\-format=\fIformat\fR] -. -.P -wp option update \fIkey\fR [\-\-format=\fIformat\fR] -. -.SH "SUBCOMMANDS" -. -.TP -\fBadd\fR: -. -.IP -Add an option\. -. -.TP -\fBdelete\fR: -. -.IP -Delete an option\. -. -.TP -\fBget\fR: -. -.IP -Get an option\. -. -.TP -\fBupdate\fR: -. -.IP -Update an option\. -. -.SH "OPTIONS" -. -.TP -\fB\-\-format=json\fR: -. -.IP -Encode/decode values as JSON\. -. -.SH "EXAMPLES" -. -.nf - -wp option get siteurl - -wp option add my_option foobar - -wp option update my_option \'{"foo": "bar"}\' \-\-format=json - -wp option delete my_option -. -.fi - diff --git a/man/plugin-activate.1 b/man/plugin-activate.1 deleted file mode 100644 index a5355ada74..0000000000 --- a/man/plugin-activate.1 +++ /dev/null @@ -1,25 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-ACTIVATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-activate\fR \- Activate a plugin\. -. -.SH "SYNOPSIS" -wp plugin activate \fIplugin\fR [\-\-network] -. -.SH "OPTIONS" -. -.TP -\fB<plugin>\fR: -. -.IP -The plugin to activate\. -. -.TP -\fB\-\-network\fR: -. -.IP -If set, the plugin will be activated for the entire multisite network\. - diff --git a/man/plugin-deactivate.1 b/man/plugin-deactivate.1 deleted file mode 100644 index 332b91a115..0000000000 --- a/man/plugin-deactivate.1 +++ /dev/null @@ -1,25 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-DEACTIVATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-deactivate\fR \- Deactivate a plugin\. -. -.SH "SYNOPSIS" -wp plugin deactivate \fIplugin\fR [\-\-network] -. -.SH "OPTIONS" -. -.TP -\fB<plugin>\fR: -. -.IP -The plugin to deactivate\. -. -.TP -\fB\-\-network\fR: -. -.IP -If set, the plugin will be deactivated for the entire multisite network\. - diff --git a/man/plugin-delete.1 b/man/plugin-delete.1 deleted file mode 100644 index 41b1927e0b..0000000000 --- a/man/plugin-delete.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-delete\fR \- Delete plugin files\. -. -.SH "SYNOPSIS" -wp plugin delete \fIplugin\fR -. -.SH "OPTIONS" -. -.TP -\fIplugin\fR: -. -.IP -The plugin to delete\. -. -.SH "EXAMPLES" -. -.nf - -wp plugin delete hello -. -.fi - diff --git a/man/plugin-install.1 b/man/plugin-install.1 deleted file mode 100644 index 557ec7db76..0000000000 --- a/man/plugin-install.1 +++ /dev/null @@ -1,43 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-INSTALL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-install\fR \- Install a plugin\. -. -.SH "SYNOPSIS" -wp plugin install \fIplugin|zip\fR [\-\-version=\fIversion\fR] [\-\-activate] -. -.SH "OPTIONS" -. -.TP -\fIplugin\fR: -. -.IP -A plugin slug or the path to a zip file\. -. -.TP -\fB\-\-version\fR=\fIversion\fR: -. -.IP -If set, get that particular version from wordpress\.org, instead of the stable version\. -. -.TP -\fB\-\-activate\fR: -. -.IP -If set, the plugin will be activated immediately after install\. -. -.SH "EXAMPLES" -. -.nf - -wp plugin install bbpress \-\-version=2\.1 \-\-activate - -wp plugin install bbpress \-\-version=dev - -wp plugin install \.\./my\-plugin\.zip -. -.fi - diff --git a/man/plugin-list.1 b/man/plugin-list.1 deleted file mode 100644 index fd23e19af9..0000000000 --- a/man/plugin-list.1 +++ /dev/null @@ -1,21 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-LIST" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-list\fR \- Get a list of plugins\. -. -.SH "SYNOPSIS" -wp plugin list [\-\-format=\fIformat\fR] -. -.SH "OPTIONS" -. -.TP -\fB\-\-format\fR=\fIformat\fR: -. -.IP -Output list as table, CSV or JSON\. Defaults to table\. -. -.SH "EXAMPLES" -wp plugin list \-\-format=json diff --git a/man/plugin-path.1 b/man/plugin-path.1 deleted file mode 100644 index 7b4b33bb07..0000000000 --- a/man/plugin-path.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-PATH" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-path\fR \- Get the path to a plugin or to the plugin directory\. -. -.SH "SYNOPSIS" -wp plugin path [\fIplugin\fR] [\-\-dir] -. -.SH "OPTIONS" -. -.TP -\fB<plugin>\fR: -. -.IP -The plugin to get the path to\. If not set, will return the path to the plugins directory\. -. -.TP -\fB\-\-dir\fR: -. -.IP -If set, get the path to the closest parent directory, instead of the plugin file\. -. -.SH "EXAMPLES" -. -.nf - -cd $(wp theme path) -. -.fi - diff --git a/man/plugin-status.1 b/man/plugin-status.1 deleted file mode 100644 index 797ffa320e..0000000000 --- a/man/plugin-status.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-STATUS" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-status\fR \- See the status of one or all plugins\. -. -.SH "SYNOPSIS" -wp plugin status [\fIplugin\fR] -. -.SH "OPTIONS" -. -.TP -\fB<plugin>\fR: -. -.IP -A particular plugin to show the status for\. - diff --git a/man/plugin-toggle.1 b/man/plugin-toggle.1 deleted file mode 100644 index 3c8e567c15..0000000000 --- a/man/plugin-toggle.1 +++ /dev/null @@ -1,25 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-TOGGLE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-toggle\fR \- Toggle a plugin\'s activation state\. -. -.SH "SYNOPSIS" -wp plugin toggle \fIplugin\fR [\-\-network] -. -.SH "OPTIONS" -. -.TP -\fB<plugin>\fR: -. -.IP -The plugin to toggle\. -. -.TP -\fB\-\-network\fR: -. -.IP -If set, the plugin will be toggled for the entire multisite network\. - diff --git a/man/plugin-uninstall.1 b/man/plugin-uninstall.1 deleted file mode 100644 index fa2fff4953..0000000000 --- a/man/plugin-uninstall.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-UNINSTALL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-uninstall\fR \- Uninstall a plugin\. -. -.SH "SYNOPSIS" -wp plugin uninstall \fIplugin\fR [\-\-no\-delete] -. -.SH "OPTIONS" -. -.TP -\fIplugin\fR: -. -.IP -The plugin to uninstall\. -. -.TP -\fB\-\-no\-delete\fR: -. -.IP -If set, the plugin files will not be deleted\. Only the uninstall procedure will be run\. -. -.SH "EXAMPLES" -. -.nf - -wp plugin uninstall hello -. -.fi - diff --git a/man/plugin-update-all.1 b/man/plugin-update-all.1 deleted file mode 100644 index ae85d459a2..0000000000 --- a/man/plugin-update-all.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-UPDATE\-ALL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-update\-all\fR \- Update all plugins\. -. -.SH "SYNOPSIS" -wp plugin update\-all [\-\-dry\-run] -. -.SH "OPTIONS" -. -.TP -\fB\-\-dry\-run\fR: -. -.IP -Pretend to do the updates, to see what would happen\. -. -.SH "EXAMPLES" -. -.nf - -wp plugin update\-all -. -.fi - diff --git a/man/plugin-update.1 b/man/plugin-update.1 deleted file mode 100644 index cd26ed8e9c..0000000000 --- a/man/plugin-update.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-PLUGIN\-UPDATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-plugin\-update\fR \- Update a plugin\. -. -.SH "SYNOPSIS" -wp plugin update \fIplugin\fR [\-\-version=\fIversion\fR] -. -.SH "OPTIONS" -. -.TP -\fIplugin\fR: -. -.IP -The plugin to update\. -. -.TP -\fB\-\-version=dev\fR: -. -.IP -If set, the plugin will be updated to the latest development version, regardless of what version is currently installed\. -. -.SH "EXAMPLES" -. -.nf - -wp plugin update bbpress \-\-version=dev -. -.fi - diff --git a/man/post-create.1 b/man/post-create.1 deleted file mode 100644 index 7dbc248443..0000000000 --- a/man/post-create.1 +++ /dev/null @@ -1,53 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-CREATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-create\fR \- Create a post\. -. -.SH "SYNOPSIS" -wp post create [\fIfilename\fR] \-\-\fIfield\fR=\fIvalue\fR [\-\-edit] [\-\-porcelain] -. -.SH "OPTIONS" -. -.TP -\fB<filename>\fR: -. -.IP -Read post content from \fIfilename\fR\. If this value is present, the \fB\-\-post_content\fR argument will be ignored\. -. -.IP -Passing \fB\-\fR as the filename will cause post content to be read from STDIN\. -. -.TP -\fB\-\-<field>\fR=\fIvalue\fR: -. -.IP -Field values for the new post\. See wp_insert_post()\. -. -.TP -\fB\-\-edit\fR: -. -.IP -Immediately open system\'s editor to write or edit post content\. -. -.IP -(If content is read from a file, from STDIN, or from the \fB\-\-post_content\fR argument, that text will be loaded into the editor; otherwise, an empty file will be opened\.) -. -.TP -\fB\-\-porcelain\fR: -. -.IP -Output just the new post id\. -. -.SH "EXAMPLES" -. -.nf - -wp post create \-\-post_type=page \-\-post_status=publish \-\-post_title=\'A future post\' \-\-post\-status=future \-\-post_date=\'2020\-12\-01 07:00:00\' - -wp post create page\.txt \-\-post_type=page \-\-post_title=\'Page from file\' -. -.fi - diff --git a/man/post-delete.1 b/man/post-delete.1 deleted file mode 100644 index f163575f26..0000000000 --- a/man/post-delete.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-delete\fR \- Delete a post by ID\. -. -.SH "SYNOPSIS" -wp post delete \fIid\fR\.\.\. [\-\-force] -. -.SH "OPTIONS" -. -.TP -\fB<ID>\fR: -. -.IP -The ID of the post to delete\. -. -.TP -\fB\-\-force\fR: -. -.IP -Skip the trash bin\. -. -.SH "EXAMPLES" -. -.nf - -wp post delete 123 \-\-force - -wp post delete $(wp post list \-\-post_type=\'page\' \-\-format=ids) -. -.fi - diff --git a/man/post-edit.1 b/man/post-edit.1 deleted file mode 100644 index 9ce9629024..0000000000 --- a/man/post-edit.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-EDIT" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-edit\fR \- Launch system editor to edit post content\. -. -.SH "SYNOPSIS" -wp post edit \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB<id>\fR: -. -.IP -The ID of the post to edit\. -. -.SH "EXAMPLES" -. -.nf - -wp post edit 123 -. -.fi - diff --git a/man/post-generate.1 b/man/post-generate.1 deleted file mode 100644 index d89efebe9d..0000000000 --- a/man/post-generate.1 +++ /dev/null @@ -1,57 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-GENERATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-generate\fR \- Generate some posts\. -. -.SH "SYNOPSIS" -wp post generate [\-\-count=\fInumber\fR] [\-\-post_type=\fItype\fR] [\-\-post_status=\fIstatus\fR] [\-\-post_author=\fIlogin\fR] [\-\-post_date=\fIyyyy\-mm\-dd\fR] [\-\-max_depth=\fInumber\fR] -. -.SH "OPTIONS" -. -.TP -\fB\-\-count\fR=\fInumber\fR: -. -.IP -How many posts to generate\. Default: 100 -. -.TP -\fB\-\-post_type\fR=\fItype\fR: -. -.IP -The type of the generated posts\. Default: \'post\' -. -.TP -\fB\-\-post_status\fR=\fIstatus\fR: -. -.IP -The status of the generated posts\. Default: \'publish\' -. -.TP -\fB\-\-post_author\fR=\fIlogin\fR: -. -.IP -The author of the generated posts\. Default: none -. -.TP -\fB\-\-post_date\fR=\fIyyyy\-mm\-dd\fR: -. -.IP -The date of the generated posts\. Default: current date -. -.TP -\fB\-\-max_depth\fR=\fInumber\fR: -. -.IP -For hierarchical post types, generate child posts down to a certain depth\. Default: 1 -. -.SH "EXAMPLES" -. -.nf - -wp post generate \-\-count=10 \-\-post_type=page \-\-post_date=1999\-01\-04 -. -.fi - diff --git a/man/post-get.1 b/man/post-get.1 deleted file mode 100644 index 94df8e63b5..0000000000 --- a/man/post-get.1 +++ /dev/null @@ -1,44 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-GET" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-get\fR \- Get a post\'s content by ID\. -. -.SH "SYNOPSIS" -wp post get [\-\-format=\fIformat\fR] \fIid\fR -. -.SH "OPTIONS" -. -.TP -\fB[\-\-format=<format>]\fR: -. -.IP -The format to use when printing the post, acceptable values: -. -.IP -\fBcontent\fR: Outputs only the post\'s content\. -. -.IP -\fBtable\fR: Outputs all fields of the post as a table\. Note that the post_content field is omitted so that the table is readable\. -. -.IP -\fBjson\fR: Outputs all fields in JSON format\. -. -.TP -\fB<id>\fR: -. -.IP -The ID of the post to get\. -. -.SH "EXAMPLES" -. -.nf - -wp post get 12 \-\-format=content - -wp post get 12 > file\.txt -. -.fi - diff --git a/man/post-list.1 b/man/post-list.1 deleted file mode 100644 index 9212454234..0000000000 --- a/man/post-list.1 +++ /dev/null @@ -1,43 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-LIST" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-list\fR \- Get a list of posts\. -. -.SH "SYNOPSIS" -wp post list [\-\-\fIfield\fR=\fIvalue\fR] [\-\-fields=\fIfields\fR] [\-\-format=\fIformat\fR] -. -.SH "OPTIONS" -. -.TP -\fB\-\-<field>\fR=\fIvalue\fR: -. -.IP -One or more args to pass to WP_Query\. -. -.TP -\fB\-\-fields\fR=\fIfields\fR: -. -.IP -Limit the output to specific object fields\. Defaults to ID,post_title,post_name,post_date,post_status\. -. -.TP -\fB\-\-format\fR=\fIformat\fR: -. -.IP -Output list as table, CSV, JSON, or simply IDs\. Defaults to table\. -. -.SH "EXAMPLES" -. -.nf - -wp post list \-\-format=ids - -wp post list \-\-post_type=post \-\-posts_per_page=5 \-\-format=json - -wp post list \-\-post_type=page \-\-fields=post_title,post_status -. -.fi - diff --git a/man/post-meta.1 b/man/post-meta.1 deleted file mode 100644 index 90398260aa..0000000000 --- a/man/post-meta.1 +++ /dev/null @@ -1,62 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-META" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-meta\fR \- Manage post custom fields\. -. -.SH "SYNOPSIS" -wp post\-meta add \fIid\fR \fIkey\fR \fIvalue\fR [\-\-format=\fIformat\fR] -. -.P -wp post\-meta delete \fIid\fR \fIkey\fR -. -.P -wp post\-meta get \fIid\fR \fIkey\fR [\-\-format=\fIformat\fR] -. -.P -wp post\-meta update \fIid\fR \fIkey\fR \fIvalue\fR [\-\-format=\fIformat\fR] -. -.SH "SUBCOMMANDS" -. -.TP -\fBadd\fR: -. -.IP -Add a meta field\. -. -.TP -\fBdelete\fR: -. -.IP -Delete a meta field\. -. -.TP -\fBget\fR: -. -.IP -Get meta field value\. -. -.TP -\fBupdate\fR: -. -.IP -Update a meta field\. -. -.SH "OPTIONS" -. -.TP -\fB\-\-format=json\fR: -. -.IP -Encode/decode values as JSON\. -. -.SH "EXAMPLES" -. -.nf - -wp post\-meta set 123 _wp_page_template about\.php -. -.fi - diff --git a/man/post-update.1 b/man/post-update.1 deleted file mode 100644 index 91b69b6b52..0000000000 --- a/man/post-update.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-POST\-UPDATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-post\-update\fR \- Update one or more posts\. -. -.SH "SYNOPSIS" -wp post update \fIid\fR\.\.\. \-\-\fIfield\fR=\fIvalue\fR -. -.SH "OPTIONS" -. -.TP -\fB<ID>\fR: -. -.IP -The ID of the post to update\. -. -.TP -\fB\-\-<field>\fR=\fIvalue\fR: -. -.IP -One or more fields to update\. See wp_update_post()\. -. -.SH "EXAMPLES" -. -.nf - -wp post update 123 \-\-post_name=something \-\-post_status=draft -. -.fi - diff --git a/man/rewrite-dump.1 b/man/rewrite-dump.1 deleted file mode 100644 index a5e9c33d3a..0000000000 --- a/man/rewrite-dump.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-REWRITE\-DUMP" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-rewrite\-dump\fR \- Print current rewrite rules\. -. -.SH "SYNOPSIS" -wp rewrite dump [\-\-json] -. -.SH "OPTIONS" -. -.TP -\fB\-\-format=json\fR: -. -.IP -Output rules in JSON format\. - diff --git a/man/rewrite-flush.1 b/man/rewrite-flush.1 deleted file mode 100644 index 622e11e126..0000000000 --- a/man/rewrite-flush.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-REWRITE\-FLUSH" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-rewrite\-flush\fR \- Flush rewrite rules\. -. -.SH "SYNOPSIS" -wp rewrite flush [\-\-soft] -. -.SH "OPTIONS" -. -.TP -\fB\-\-soft\fR: -. -.IP -Perform a soft flush \- do not overwrite \fB\.htaccess\fR\. The default is to update \fB\.htaccess\fR rules as well as rewrite rules in database\. - diff --git a/man/rewrite-structure.1 b/man/rewrite-structure.1 deleted file mode 100644 index 50272811d0..0000000000 --- a/man/rewrite-structure.1 +++ /dev/null @@ -1,31 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-REWRITE\-STRUCTURE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-rewrite\-structure\fR \- Update the permalink structure\. -. -.SH "SYNOPSIS" -wp rewrite structure \fIpermastruct\fR [\-\-category\-base=\fIbase\fR] [\-\-tag\-base=\fIbase\fR] -. -.SH "OPTIONS" -. -.TP -\fIpermastruct\fR: -. -.IP -The new permalink structure to apply; like "/%year%/%monthnum%/%postname%"\. -. -.TP -\fB\-\-category\-base\fR=\fIcategorybase\fR: -. -.IP -Set the base for category permalinks, ie \'/category/\'\. -. -.TP -\fB\-\-tag\-base\fR=\fItagbase\fR: -. -.IP -Set the base for tag permalinks, ie \'/tag/\'\. - diff --git a/man/role-create.1 b/man/role-create.1 deleted file mode 100644 index 4737ed2b0c..0000000000 --- a/man/role-create.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-ROLE\-CREATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-role\-create\fR \- Create a new role\. -. -.SH "SYNOPSIS" -wp role create \fIrole\-key\fR \fIrole\-name\fR -. -.SH "OPTIONS" -. -.TP -\fIrole\-key\fR: -. -.IP -The internal name of the role, e\.g\. editor -. -.TP -\fIrole\-name\fR: -. -.IP -The publically visible name of the role, e\.g\. Editor -. -.SH "EXAMPLES" -. -.nf - -wp role create approver Approver - -wp role create productadmin "Product Administrator" -. -.fi - diff --git a/man/role-delete.1 b/man/role-delete.1 deleted file mode 100644 index 02375d3693..0000000000 --- a/man/role-delete.1 +++ /dev/null @@ -1,29 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-ROLE\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-role\-delete\fR \- Delete an existing role\. -. -.SH "SYNOPSIS" -wp role delete \fIrole\-key\fR -. -.SH "OPTIONS" -. -.TP -\fIrole\-key\fR: -. -.IP -The internal name of the role, e\.g\. editor -. -.SH "EXAMPLES" -. -.nf - -wp role delete approver - -wp role delete productadmin -. -.fi - diff --git a/man/role-exists.1 b/man/role-exists.1 deleted file mode 100644 index 7db3baa31f..0000000000 --- a/man/role-exists.1 +++ /dev/null @@ -1,30 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-ROLE\-EXISTS" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-role\-exists\fR \- Check if a role exists\. -. -.SH "SYNOPSIS" -wp role exists \fIrole\-key\fR -. -.SH "OPTIONS" -. -.TP -\fIrole\-key\fR: -. -.IP -The internal name of the role, e\.g\. editor -. -.SH "DESCRIPTION" -Will exit with status 0 if the role exists, 1 if it does not\. -. -.SH "EXAMPLES" -. -.nf - -wp role exists editor -. -.fi - diff --git a/man/role-list.1 b/man/role-list.1 deleted file mode 100644 index 14d58a8b85..0000000000 --- a/man/role-list.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-ROLE\-LIST" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-role\-list\fR \- List all roles\. -. -.SH "SYNOPSIS" -wp role list [\-\-fields=\fIfields\fR] [\-\-format=\fIformat\fR] -. -.SH "OPTIONS" -. -.TP -\fB\-\-fields\fR=\fIfields\fR: -. -.IP -Limit the output to specific object fields\. Defaults to name,role\. -. -.TP -\fB\-\-format\fR=\fIformat\fR: -. -.IP -Output list as table, CSV or JSON\. Defaults to table\. -. -.SH "EXAMPLES" -. -.nf - -wp role list \-\-fields=role \-\-format=csv -. -.fi - diff --git a/man/scaffold-_s.1 b/man/scaffold-_s.1 deleted file mode 100644 index d6ee0407ce..0000000000 --- a/man/scaffold-_s.1 +++ /dev/null @@ -1,43 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SCAFFOLD\-_S" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-scaffold\-_s\fR \- Generate starter code for a theme\. -. -.SH "SYNOPSIS" -wp scaffold _s \fIslug\fR [\-\-theme_name=\fItitle\fR] [\-\-author=\fIfull\-name\fR] [\-\-author_uri=\fIhttp\-url\fR] [\-\-activate] -. -.SH "OPTIONS" -. -.TP -\fIslug\fR: -. -.IP -The slug for the new theme, used for prefixing functions\. -. -.TP -\fB\-\-activate\fR: -. -.IP -Activate the newly downloaded theme\. -. -.TP -\fB\-\-theme_name=<title>\fR: -. -.IP -What to put in the \'Theme Name:\' header in style\.css -. -.TP -\fB\-\-author=<full name>\fR: -. -.IP -What to put in the \'Author:\' header in style\.css -. -.TP -\fB\-\-author_uri=<http url>\fR: -. -.IP -What to put in the \'Author URI:\' header in style\.css - diff --git a/man/scaffold-child-theme.1 b/man/scaffold-child-theme.1 deleted file mode 100644 index 67fa5bcd3f..0000000000 --- a/man/scaffold-child-theme.1 +++ /dev/null @@ -1,55 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SCAFFOLD\-CHILD\-THEME" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-scaffold\-child\-theme\fR \- Generate empty child theme\. -. -.SH "SYNOPSIS" -wp scaffold child\-theme \fIslug\fR \-\-parent_theme=\fIslug\fR [\-\-theme_name=\fItitle\fR] [\-\-author=\fIfull\-name\fR] [\-\-author_uri=\fIhttp\-url\fR] [\-\-theme_uri=\fIhttp\-url\fR] [\-\-activate] -. -.SH "OPTIONS" -. -.TP -\fIslug\fR: -. -.IP -The slug for the new child theme\. -. -.TP -\fB\-\-parent_theme=<slug>\fR: -. -.IP -What to put in the \'Template:\' header in style\.css -. -.TP -\fB\-\-theme_name=<title>\fR: -. -.IP -What to put in the \'Theme Name:\' header in style\.css -. -.TP -\fB\-\-author=<full name>\fR: -. -.IP -What to put in the \'Author:\' header in style\.css -. -.TP -\fB\-\-author_uri=<http url>\fR: -. -.IP -What to put in the \'Author URI:\' header in style\.css -. -.TP -\fB\-\-theme_uri=<http url>\fR: -. -.IP -What to put in the \'Theme URI:\' header in style\.css -. -.TP -\fB\-\-activate\fR: -. -.IP -Activate the newly created child theme\. - diff --git a/man/scaffold-plugin-tests.1 b/man/scaffold-plugin-tests.1 deleted file mode 100644 index 5c0a07ee5e..0000000000 --- a/man/scaffold-plugin-tests.1 +++ /dev/null @@ -1,39 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SCAFFOLD\-PLUGIN\-TESTS" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-scaffold\-plugin\-tests\fR \- Generate files needed for running PHPUnit tests\. -. -.SH "SYNOPSIS" -wp scaffold plugin\-tests \fIplugin\fR -. -.SH "DESCRIPTION" -These are the files that are generated: -. -.IP "\(bu" 4 -\fBphpunit\.xml\fR is the configuration file for PHPUnit -. -.IP "\(bu" 4 -\fB\.travis\.yml\fR is the configuration file for Travis CI -. -.IP "\(bu" 4 -\fBtests/bootstrap\.php\fR is the file that makes the current plugin active when running the test suite -. -.IP "\(bu" 4 -\fBtests/test\-sample\.php\fR is a sample file containing the actual tests -. -.IP "" 0 -. -.SH "ENVIRONMENT" -The \fBtests/bootstrap\.php\fR file looks for the WP_TESTS_DIR environment variable\. -. -.SH "EXAMPLE" -. -.nf - -wp scaffold plugin\-tests hello -. -.fi - diff --git a/man/scaffold-plugin.1 b/man/scaffold-plugin.1 deleted file mode 100644 index f91ec221e5..0000000000 --- a/man/scaffold-plugin.1 +++ /dev/null @@ -1,25 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SCAFFOLD\-PLUGIN" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-scaffold\-plugin\fR \- Generate starter code for a plugin\. -. -.SH "SYNOPSIS" -wp scaffold plugin \fIslug\fR [\-\-plugin_name=\fItitle\fR] [\-\-activate] -. -.SH "OPTIONS" -. -.TP -\fB\-\-activate\fR: -. -.IP -Activate the newly generated plugin\. -. -.TP -\fB\-\-plugin_name=<title>\fR: -. -.IP -What to put in the \'Plugin Name:\' header - diff --git a/man/scaffold-post-type.1 b/man/scaffold-post-type.1 deleted file mode 100644 index 6db8bf44c2..0000000000 --- a/man/scaffold-post-type.1 +++ /dev/null @@ -1,43 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SCAFFOLD\-POST\-TYPE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-scaffold\-post\-type\fR \- Generate PHP code for registering a custom post type\. -. -.SH "SYNOPSIS" -wp scaffold post\-type \fIslug\fR [\-\-label=\fIlabel\fR] [\-\-textdomain=\fItextdomain\fR] [\-\-theme] [\-\-plugin=\fIplugin\fR] [\-\-raw] -. -.SH "OPTIONS" -. -.TP -\fB\-\-label=<label>\fR: -. -.IP -The text used to translate the update messages -. -.TP -\fB\-\-textdomain=<textdomain>\fR: -. -.IP -The textdomain to use for the labels\. -. -.TP -\fB\-\-theme\fR: -. -.IP -Create a file in the active theme directory, instead of sending to STDOUT\. Specify a theme with \fB\-\-theme=<theme>\fR to have the file placed in that theme\. -. -.TP -\fB\-\-plugin=<plugin>\fR: -. -.IP -Create a file in the given plugin\'s directory, instead of sending to STDOUT\. -. -.TP -\fB\-\-raw\fR: -. -.IP -Just generate the \fBregister_post_type()\fR call and nothing else\. - diff --git a/man/scaffold-taxonomy.1 b/man/scaffold-taxonomy.1 deleted file mode 100644 index 3d7986f2e1..0000000000 --- a/man/scaffold-taxonomy.1 +++ /dev/null @@ -1,57 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SCAFFOLD\-TAXONOMY" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-scaffold\-taxonomy\fR \- Generate PHP code for registering a custom taxonomy\. -. -.SH "SYNOPSIS" -wp scaffold taxonomy \fIslug\fR [\-\-post_types=\fIpost\-types\fR] [\-\-label=\fIlabel\fR] [\-\-textdomain=\fItextdomain\fR] [\-\-theme] [\-\-plugin=\fIplugin\fR] [\-\-raw] -. -.SH "OPTIONS" -. -.TP -\fB\-\-post_types=<post_types>\fR: -. -.IP -Post types to register for use with the taxonomy\. -. -.TP -\fB\-\-label=<label>\fR: -. -.IP -The text used to translate the update messages -. -.TP -\fB\-\-textdomain=<textdomain>\fR: -. -.IP -The textdomain to use for the labels\. -. -.TP -\fB\-\-theme\fR: -. -.IP -Create a file in the active theme directory, instead of sending to STDOUT\. Specify a theme with \fB\-\-theme=<theme>\fR to have the file placed in that theme\. -. -.TP -\fB\-\-plugin=<plugin>\fR: -. -.IP -Create a file in the given plugin\'s directory, instead of sending to STDOUT\. -. -.TP -\fB\-\-raw\fR: -. -.IP -Just generate the \fBregister_taxonomy()\fR call and nothing else\. -. -.SH "EXAMPLES" -. -.nf - -wp scaffold taxonomy venue \-\-post_types=event,presentation -. -.fi - diff --git a/man/search-replace.1 b/man/search-replace.1 deleted file mode 100644 index 6af388a6eb..0000000000 --- a/man/search-replace.1 +++ /dev/null @@ -1,47 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SEARCH\-REPLACE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-search\-replace\fR \- Search/replace strings in the database\. -. -.SH "SYNOPSIS" -wp search\-replace \fIold\fR \fInew\fR [\fItable\fR\.\.\.] [\-\-skip\-columns=\fIcolumns\fR] [\-\-dry\-run] [\-\-network] -. -.SH "DESCRIPTION" -This command will go through all rows in all tables and will replace all appearances of the old string with the new one\. -. -.P -It will correctly handle serialized values, and will not change primary key values\. -. -.SH "OPTIONS" -. -.TP -\fB\-\-network\fR: -. -.IP -Search/replace through all the tables in a multisite install\. -. -.TP -\fB\-\-skip\-columns=<columns>\fR: -. -.IP -Do not perform the replacement in the comma\-separated columns\. -. -.TP -\fB\-\-dry\-run\fR: -. -.IP -Show report, but don\'t perform the changes\. -. -.SH "EXAMPLES" -. -.nf - -wp search\-replace \'http://example\.dev\' \'http://example\.com\' \-\-skip\-columns=guid - -wp search\-replace \'foo\' \'bar\' wp_posts wp_postmeta wp_terms \-\-dry\-run -. -.fi - diff --git a/man/shell.1 b/man/shell.1 deleted file mode 100644 index 6aa5f9e1f1..0000000000 --- a/man/shell.1 +++ /dev/null @@ -1,22 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SHELL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-shell\fR \- Interactive PHP console\. -. -.SH "SYNOPSIS" -wp shell [\-\-basic] -. -.SH "DESCRIPTION" -\fBwp shell\fR allows you to evaluate PHP statements and expressions interactively, from within a WordPress environment\. This means that you have access to all the functions, classes and globals that you would have access to from inside a WordPress plugin, for example\. -. -.SH "OPTIONS" -. -.TP -\fB\-\-basic\fR: -. -.IP -Start in fail\-safe mode, even if Boris is available\. - diff --git a/man/site-create.1 b/man/site-create.1 deleted file mode 100644 index 20675a3e6a..0000000000 --- a/man/site-create.1 +++ /dev/null @@ -1,49 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SITE\-CREATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-site\-create\fR \- Create a site in a multisite install\. -. -.SH "SYNOPSIS" -wp site create \-\-slug=\fIslug\fR [\-\-title=\fItitle\fR] [\-\-email=\fIemail\fR] [\-\-network_id=\fInetwork\-id\fR] [\-\-private] [\-\-porcelain] -. -.SH "OPTIONS" -. -.TP -\fB\-\-slug\fR=\fIslug\fR: -. -.IP -Path for the new site\. Subdomain on subdomain installs, directory on subdirectory installs\. -. -.TP -\fB\-\-title\fR=<title>: -. -.IP -Title of the new site\. Default: prettified slug\. -. -.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\-\-network_id\fR=\fInetwork\-id\fR: -. -.IP -Network to associate new site with\. Defaults to current network (typically 1)\. -. -.TP -\fB\-\-private\fR: -. -.IP -If set, the new site will be non\-public (not indexed) -. -.TP -\fB\-\-porcelain\fR: -. -.IP -If set, only the site id will be output on success\. - diff --git a/man/site-delete.1 b/man/site-delete.1 deleted file mode 100644 index d8f7f3bc3d..0000000000 --- a/man/site-delete.1 +++ /dev/null @@ -1,37 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SITE\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-site\-delete\fR \- Delete a site in a multisite install\. -. -.SH "SYNOPSIS" -wp site delete [\fIsite\-id\fR] [\-\-slug=\fIslug\fR] [\-\-yes] [\-\-keep\-tables] -. -.SH "OPTIONS" -. -.TP -\fB<blog\-id>\fR: -. -.IP -The id of the blog to delete\. If not provided, you must set the \-\-slug parameter\. -. -.TP -\fB\-\-slug\fR=\fIslug\fR: -. -.IP -Path of the blog to be deleted\. Subdomain on subdomain installs, directory on subdirectory installs\. -. -.TP -\fB\-\-yes\fR: -. -.IP -Answer yes to the confirmation message\. -. -.TP -\fB\-\-keep\-tables\fR: -. -.IP -Delete the blog from the list, but don\'t drop it\'s tables\. - diff --git a/man/site-empty.1 b/man/site-empty.1 deleted file mode 100644 index 144391fba1..0000000000 --- a/man/site-empty.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-SITE\-EMPTY" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-site\-empty\fR \- Empty a site of its content\. -. -.SH "SYNOPSIS" -wp site empty [\-\-yes] -. -.SH "EXAMPLES" -. -.nf - -wp blog empty -. -.fi - diff --git a/man/term-create.1 b/man/term-create.1 deleted file mode 100644 index 366ee1a886..0000000000 --- a/man/term-create.1 +++ /dev/null @@ -1,57 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-TERM\-CREATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-term\-create\fR \- Create a term\. -. -.SH "SYNOPSIS" -wp term create \fIterm\fR \fItaxonomy\fR [\-\-slug=\fIslug\fR] [\-\-description=\fIdescription\fR] [\-\-parent=\fIterm\-id\fR] [\-\-porcelain] -. -.SH "OPTIONS" -. -.TP -\fB<term>\fR: -. -.IP -A name for the new term\. -. -.TP -\fB<taxonomy>\fR: -. -.IP -Taxonomy for the new term\. -. -.TP -\fB\-\-slug\fR=\fIslug\fR: -. -.IP -A unique slug for the new term\. Defaults to sanitized version of name\. -. -.TP -\fB\-\-description\fR=\fIdescription\fR: -. -.IP -A description for the new term\. -. -.TP -\fB\-\-parent\fR=\fIterm\-id\fR: -. -.IP -A parent for the new term\. -. -.TP -\fB\-\-porcelain\fR: -. -.IP -Output just the new term id\. -. -.SH "EXAMPLES" -. -.nf - -wp term create Apple category \-\-description="A type of fruit" -. -.fi - diff --git a/man/term-delete.1 b/man/term-delete.1 deleted file mode 100644 index 1a9700510f..0000000000 --- a/man/term-delete.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-TERM\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-term\-delete\fR \- Delete a term\. -. -.SH "SYNOPSIS" -wp term delete \fIterm\-id\fR \fItaxonomy\fR -. -.SH "OPTIONS" -. -.TP -\fB<term\-id>\fR: -. -.IP -ID for the term to delete\. -. -.TP -\fB<taxonomy>\fR: -. -.IP -Taxonomy of the term to delete\. -. -.SH "EXAMPLES" -. -.nf - -wp term delete 15 category -. -.fi - diff --git a/man/term-list.1 b/man/term-list.1 deleted file mode 100644 index ef15301912..0000000000 --- a/man/term-list.1 +++ /dev/null @@ -1,41 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-TERM\-LIST" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-term\-list\fR \- List terms in a taxonomy\. -. -.SH "SYNOPSIS" -wp term list \fItaxonomy\fR [\-\-fields=\fIfields\fR] [\-\-format=\fIformat\fR] -. -.SH "OPTIONS" -. -.TP -\fB<taxonomy>\fR: -. -.IP -List terms of a given taxonomy\. -. -.TP -\fB\-\-fields\fR=\fIfields\fR: -. -.IP -Limit the output to specific object fields\. Defaults to all of the term object fields\. -. -.TP -\fB\-\-format\fR=\fIformat\fR: -. -.IP -Output list as table, CSV, JSON, or simply IDs\. Defaults to table\. -. -.SH "EXAMPLES" -. -.nf - -wp term list category \-\-format=csv - -wp term list post_tag \-\-fields=name,slug -. -.fi - diff --git a/man/term-update.1 b/man/term-update.1 deleted file mode 100644 index 34bf099def..0000000000 --- a/man/term-update.1 +++ /dev/null @@ -1,57 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-TERM\-UPDATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-term\-update\fR \- Update a term\. -. -.SH "SYNOPSIS" -wp term update \fIterm\-id\fR \fItaxonomy\fR [\-\-name=\fIname\fR] [\-\-slug=\fIslug\fR] [\-\-description=\fIdescription\fR] [\-\-parent=\fIterm\-id\fR] -. -.SH "OPTIONS" -. -.TP -\fB<term\-id>\fR: -. -.IP -ID for the term to update\. -. -.TP -\fB<taxonomy>\fR: -. -.IP -Taxonomy of the term to update\. -. -.TP -\fB\-\-name\fR=\fIname\fR: -. -.IP -A new name for the term\. -. -.TP -\fB\-\-slug\fR=\fIslug\fR: -. -.IP -A new slug for the term\. -. -.TP -\fB\-\-description\fR=\fIdescription\fR: -. -.IP -A new description for the term\. -. -.TP -\fB\-\-parent\fR=\fIterm\-id\fR: -. -.IP -A new parent for the term\. -. -.SH "EXAMPLES" -. -.nf - -wp term update 15 category \-\-name=Apple -. -.fi - diff --git a/man/theme-activate.1 b/man/theme-activate.1 deleted file mode 100644 index 52f33f8b4d..0000000000 --- a/man/theme-activate.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-ACTIVATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-activate\fR \- Activate a theme\. -. -.SH "SYNOPSIS" -wp theme activate \fItheme\fR -. -.SH "OPTIONS" -. -.TP -\fB<theme>\fR: -. -.IP -The theme to activate\. - diff --git a/man/theme-delete.1 b/man/theme-delete.1 deleted file mode 100644 index 3bfae3759f..0000000000 --- a/man/theme-delete.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-delete\fR \- Delete a theme\. -. -.SH "SYNOPSIS" -wp theme delete \fItheme\fR -. -.SH "OPTIONS" -. -.TP -\fB<theme>\fR: -. -.IP -The theme to delete\. -. -.SH "EXAMPLES" -. -.nf - -wp theme delete twentyeleven -. -.fi - diff --git a/man/theme-install.1 b/man/theme-install.1 deleted file mode 100644 index 5e74e7c305..0000000000 --- a/man/theme-install.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-INSTALL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-install\fR \- Install a theme\. -. -.SH "SYNOPSIS" -wp theme install \fItheme|zip\fR [\-\-version=\fIversion\fR] [\-\-activate] -. -.SH "OPTIONS" -. -.TP -\fB<theme>\fR: -. -.IP -A theme slug or the path to a zip file\. -. -.TP -\fB\-\-activate\fR: -. -.IP -If set, the theme will be activated immediately after install\. -. -.SH "EXAMPLES" -. -.nf - -wp theme install twentytwelve \-\-activate - -wp theme install \.\./my\-theme\.zip -. -.fi - diff --git a/man/theme-list.1 b/man/theme-list.1 deleted file mode 100644 index 96436899fe..0000000000 --- a/man/theme-list.1 +++ /dev/null @@ -1,21 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-LIST" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-list\fR \- Get a list of themes\. -. -.SH "SYNOPSIS" -wp theme list [\-\-format=\fIformat\fR] -. -.SH "OPTIONS" -. -.TP -\fB\-\-format\fR=\fIformat\fR: -. -.IP -Output list as table, CSV or JSON\. Defaults to table\. -. -.SH "EXAMPLES" -wp theme list \-\-format=csv diff --git a/man/theme-path.1 b/man/theme-path.1 deleted file mode 100644 index b657808c8d..0000000000 --- a/man/theme-path.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-PATH" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-path\fR \- Get the path to a theme or to the theme directory\. -. -.SH "SYNOPSIS" -wp theme path [\fItheme\fR] [\-\-dir] -. -.SH "OPTIONS" -. -.TP -\fB<theme>\fR: -. -.IP -The theme to get the path to\. If not set, will return the path to the themes directory\. -. -.TP -\fB\-\-dir\fR: -. -.IP -If set, get the path to the closest parent directory, instead of the theme file\. -. -.SH "EXAMPLES" -. -.nf - -cd $(wp theme path) -. -.fi - diff --git a/man/theme-status.1 b/man/theme-status.1 deleted file mode 100644 index 89fb262e69..0000000000 --- a/man/theme-status.1 +++ /dev/null @@ -1,19 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-STATUS" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-status\fR \- See the status of one or all themes\. -. -.SH "SYNOPSIS" -wp theme status [\fItheme\fR] -. -.SH "OPTIONS" -. -.TP -\fB<theme>\fR: -. -.IP -A particular theme to show the status for\. - diff --git a/man/theme-update-all.1 b/man/theme-update-all.1 deleted file mode 100644 index 82f580ff9f..0000000000 --- a/man/theme-update-all.1 +++ /dev/null @@ -1,27 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-UPDATE\-ALL" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-update\-all\fR \- Update all themes\. -. -.SH "SYNOPSIS" -wp theme update\-all [\-\-dry\-run] -. -.SH "OPTIONS" -. -.TP -\fB\-\-dry\-run\fR: -. -.IP -Pretend to do the updates, to see what would happen\. -. -.SH "EXAMPLES" -. -.nf - -wp theme update\-all -. -.fi - diff --git a/man/theme-update.1 b/man/theme-update.1 deleted file mode 100644 index 7e877c8172..0000000000 --- a/man/theme-update.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-THEME\-UPDATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-theme\-update\fR \- Update a theme\. -. -.SH "SYNOPSIS" -wp theme update \fItheme\fR [\-\-version=\fIversion\fR] -. -.SH "OPTIONS" -. -.TP -\fB<theme>\fR: -. -.IP -The theme to update\. -. -.TP -\fB\-\-version=dev\fR: -. -.IP -If set, the theme will be updated to the latest development version, regardless of what version is currently installed\. -. -.SH "EXAMPLES" -. -.nf - -wp theme update twentytwelve -. -.fi - diff --git a/man/transient.1 b/man/transient.1 deleted file mode 100644 index e3fd1ddd1e..0000000000 --- a/man/transient.1 +++ /dev/null @@ -1,54 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-TRANSIENT" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-transient\fR \- Manage WordPress transients\. -. -.SH "SYNOPSIS" -wp transient delete \fIkey\fR -. -.P -wp transient get \fIkey\fR [\-\-json] -. -.P -wp transient set \fIkey\fR \fIvalue\fR [\fIexpiration\fR] -. -.P -wp transient type -. -.SH "SUBCOMMANDS" -. -.TP -\fBdelete\fR: -. -.IP -Delete a transient value\. -. -.TP -\fBget\fR: -. -.IP -Get a transient value\. -. -.TP -\fBset\fR: -. -.IP -Set a transient value\. <expiration> is the time until expiration, in seconds\. -. -.TP -\fBtype\fR: -. -.IP -See wether the transients API is using an object cache or the options table\. -. -.SH "EXAMPLES" -. -.nf - -wp transient set my_key my_value 300 -. -.fi - diff --git a/man/user-create.1 b/man/user-create.1 deleted file mode 100644 index 6eadf9ec9c..0000000000 --- a/man/user-create.1 +++ /dev/null @@ -1,63 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-CREATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-create\fR \- Create a user\. -. -.SH "SYNOPSIS" -wp user create \fIuser\-login\fR \fIuser\-email\fR [\-\-role=\fIrole\fR] [\-\-user_pass=\fIpassword\fR] [\-\-user_registered=\fIyyyy\-mm\-dd\fR] [\-\-display_name=\fIname\fR] [\-\-porcelain] -. -.SH "OPTIONS" -. -.TP -\fB<user\-login>\fR: -. -.IP -The login of the user to create\. -. -.TP -\fB<user\-email>\fR: -. -.IP -The email address of the user to create\. -. -.TP -\fB\-\-role\fR=\fIrole\fR: -. -.IP -The role of the user to create\. Default: default role -. -.TP -\fB\-\-user_pass\fR=\fIpassword\fR: -. -.IP -The user password\. Default: randomly generated -. -.TP -\fB\-\-user_registered\fR=\fIyyyy\-mm\-dd\fR: -. -.IP -The date the user registered\. Default: current date -. -.TP -\fB\-\-display_name\fR=\fIname\fR: -. -.IP -The display name\. -. -.TP -\fB\-\-porcelain\fR: -. -.IP -Output just the new user id\. -. -.SH "EXAMPLES" -. -.nf - -wp user create bob bob@example\.com \-\-role=author -. -.fi - diff --git a/man/user-delete.1 b/man/user-delete.1 deleted file mode 100644 index d498eb4153..0000000000 --- a/man/user-delete.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-DELETE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-delete\fR \- Delete one or more users\. -. -.SH "SYNOPSIS" -wp user delete \fIid\fR\.\.\. [\-\-reassign=\fIid\fR] -. -.SH "OPTIONS" -. -.TP -\fB<ID>\fR: -. -.IP -The ID of the user to delete\. -. -.TP -\fB\-\-reassign\fR=\fIID\fR: -. -.IP -User to reassign the posts to\. -. -.SH "EXAMPLES" -. -.nf - -wp user delete 123 \-\-reassign=567 -. -.fi - diff --git a/man/user-generate.1 b/man/user-generate.1 deleted file mode 100644 index 3c87b5c76b..0000000000 --- a/man/user-generate.1 +++ /dev/null @@ -1,25 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-GENERATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-generate\fR \- Generate users\. -. -.SH "SYNOPSIS" -wp user generate [\-\-count=\fInumber\fR] [\-\-role=\fIrole\fR] -. -.SH "OPTIONS" -. -.TP -\fB\-\-count\fR=\fInumber\fR: -. -.IP -How many users to generate\. Default: 100 -. -.TP -\fB\-\-role\fR=\fIrole\fR: -. -.IP -The role of the generated users\. Default: default role from WP - diff --git a/man/user-import-csv.1 b/man/user-import-csv.1 deleted file mode 100644 index 0c3d07c7a1..0000000000 --- a/man/user-import-csv.1 +++ /dev/null @@ -1,34 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-IMPORT\-CSV" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-import\-csv\fR \- Import users from a CSV file\. -. -.SH "SYNOPSIS" -wp user import\-csv \fIfile\fR -. -.SH "OPTIONS" -. -.TP -\fB<file>\fR: -. -.IP -The CSV file of users to import\. -. -.SH "EXAMPLES" -. -.nf - -wp user import\-csv /path/to/users\.csv - -Sample users\.csv file: - -user_login,user_email,display_name,role -bobjones,bobjones@domain\.com,Bob Jones,contributor -newuser1,newuser1@domain\.com,New User,author -existinguser,existinguser@domain\.com,Existing User,administrator -. -.fi - diff --git a/man/user-list.1 b/man/user-list.1 deleted file mode 100644 index f5dac94ed1..0000000000 --- a/man/user-list.1 +++ /dev/null @@ -1,43 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-LIST" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-list\fR \- List users\. -. -.SH "SYNOPSIS" -wp user list [\-\-role=\fIrole\fR] [\-\-fields=\fIfields\fR] [\-\-format=\fIformat\fR] -. -.SH "OPTIONS" -. -.TP -\fB\-\-role\fR=\fIrole\fR: -. -.IP -Only display users with a certain role\. -. -.TP -\fB\-\-fields\fR=\fIfields\fR: -. -.IP -Limit the output to specific object fields\. Defaults to ID,user_login,display_name,user_email,user_registered,roles -. -.TP -\fB\-\-format\fR=\fIformat\fR: -. -.IP -Output list as table, CSV, JSON, or simply IDs\. Defaults to table\. -. -.SH "EXAMPLES" -. -.nf - -wp user list \-\-format=ids - -wp user list \-\-role=administrator \-\-format=csv - -wp user list \-\-fields=display_name,user_email -. -.fi - diff --git a/man/user-meta.1 b/man/user-meta.1 deleted file mode 100644 index 817491f42e..0000000000 --- a/man/user-meta.1 +++ /dev/null @@ -1,62 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-META" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-meta\fR \- Manage user custom fields\. -. -.SH "SYNOPSIS" -wp user\-meta add \fIid\fR \fIkey\fR \fIvalue\fR [\-\-format=\fIformat\fR] -. -.P -wp user\-meta delete \fIid\fR \fIkey\fR -. -.P -wp user\-meta get \fIid\fR \fIkey\fR [\-\-format=\fIformat\fR] -. -.P -wp user\-meta update \fIid\fR \fIkey\fR \fIvalue\fR [\-\-format=\fIformat\fR] -. -.SH "SUBCOMMANDS" -. -.TP -\fBadd\fR: -. -.IP -Add a meta field\. -. -.TP -\fBdelete\fR: -. -.IP -Delete a meta field\. -. -.TP -\fBget\fR: -. -.IP -Get meta field value\. -. -.TP -\fBupdate\fR: -. -.IP -Update a meta field\. -. -.SH "OPTIONS" -. -.TP -\fB\-\-format=json\fR: -. -.IP -Encode/decode values as JSON\. -. -.SH "EXAMPLES" -. -.nf - -wp user\-meta set 123 description "Mary is a WordPress developer\." -. -.fi - diff --git a/man/user-remove-role.1 b/man/user-remove-role.1 deleted file mode 100644 index e6e0360a9c..0000000000 --- a/man/user-remove-role.1 +++ /dev/null @@ -1,28 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-REMOVE\-ROLE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-remove\-role\fR \- Remove a user\'s role\. -. -.SH "SYNOPSIS" -wp user remove\-role \fIuser\-login\fR [\fIrole\fR] [\-\-blog=\fIblog\fR] -. -.SH "OPTIONS" -. -.TP -\fB<user\-login>\fR: -. -.IP -User ID or user login\. -. -.SH "EXAMPLES" -. -.nf - -wp user remove\-role bob -wp user remove\-role 12 -. -.fi - diff --git a/man/user-set-role.1 b/man/user-set-role.1 deleted file mode 100644 index edd5ea550a..0000000000 --- a/man/user-set-role.1 +++ /dev/null @@ -1,34 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-SET\-ROLE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-set\-role\fR \- Set the user role (for a particular blog)\. -. -.SH "SYNOPSIS" -wp user set\-role \fIuser\-login\fR [\fIrole\fR] [\-\-blog=\fIblog\fR] -. -.SH "OPTIONS" -. -.TP -\fB<user\-login>\fR: -. -.IP -User ID or user login\. -. -.TP -\fB[<role>]\fR: -. -.IP -Add the user with the specified role\. Defaults to blog default\. -. -.SH "EXAMPLES" -. -.nf - -wp user set\-role bob author -wp user set\-role 12 author -. -.fi - diff --git a/man/user-update.1 b/man/user-update.1 deleted file mode 100644 index 965501ff58..0000000000 --- a/man/user-update.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" generated with Ronn/v0.7.3 -.\" http://github.com/rtomayko/ronn/tree/0.7.3 -. -.TH "WP\-USER\-UPDATE" "1" "" "WP-CLI" -. -.SH "NAME" -\fBwp\-user\-update\fR \- Update a user\. -. -.SH "SYNOPSIS" -wp user update \fIid\fR\.\.\. \-\-\fIfield\fR=\fIvalue\fR -. -.SH "OPTIONS" -. -.TP -\fB<ID>\fR: -. -.IP -The ID of the user to update\. -. -.TP -\fB\-\-<field>\fR=\fIvalue\fR: -. -.IP -One or more fields to update\. For accepted fields, see wp_update_user()\. -. -.SH "EXAMPLES" -. -.nf - -wp user update 123 \-\-user_login=mary \-\-display_name=Mary -. -.fi - diff --git a/php/WP_CLI/Dispatcher/CompositeCommand.php b/php/WP_CLI/Dispatcher/CompositeCommand.php index 14179199cd..90dc7fe1b8 100644 --- a/php/WP_CLI/Dispatcher/CompositeCommand.php +++ b/php/WP_CLI/Dispatcher/CompositeCommand.php @@ -17,7 +17,6 @@ public function __construct( $parent, $name, $docparser ) { $this->name = $name; $this->shortdesc = $docparser->get_shortdesc(); - $this->synopsis = $docparser->get_synopsis(); $when_to_invoke = $docparser->get_tag( 'when' ); if ( $when_to_invoke ) { @@ -52,7 +51,7 @@ function get_shortdesc() { } function get_synopsis() { - return $this->synopsis; + return '<subcommand>'; } function invoke( $args, $assoc_args ) { @@ -74,6 +73,28 @@ function show_usage() { \WP_CLI::line( "See 'wp help $this->name <subcommand>' for more information on a specific subcommand." ); } + function get_extra_markdown() { + $md_file = self::find_extra_markdown_file( $this ); + if ( !$md_file ) + return ''; + + return file_get_contents( $md_file ); + } + + private static function find_extra_markdown_file( $command ) { + $cmd_path = get_path( $command ); + array_shift( $cmd_path ); // discard 'wp' + $cmd_path = implode( '-', $cmd_path ); + + foreach ( \WP_CLI::get_man_dirs() as $src_dir ) { + $src_path = "$src_dir/$cmd_path.txt"; + if ( is_readable( $src_path ) ) + return $src_path; + } + + return false; + } + function find_subcommand( &$args ) { $name = array_shift( $args ); diff --git a/php/WP_CLI/Dispatcher/RootCommand.php b/php/WP_CLI/Dispatcher/RootCommand.php index 03bc8196d0..afae682215 100644 --- a/php/WP_CLI/Dispatcher/RootCommand.php +++ b/php/WP_CLI/Dispatcher/RootCommand.php @@ -14,38 +14,11 @@ function __construct() { $this->name = 'wp'; - $this->shortdesc = ''; - $this->synopsis = ''; + $this->shortdesc = 'Manage WordPress installations through the command-line.'; } - function show_usage() { - \WP_CLI::line( 'Available commands:' ); - - foreach ( $this->get_subcommands() as $command ) { - if ( '_sys' == $command->get_name() ) - continue; - - \WP_CLI::line( sprintf( ' %s %s', - implode( ' ', get_path( $command ) ), - implode( '|', array_keys( $command->get_subcommands() ) ) - ) ); - } - - \WP_CLI::line(<<<EOB - -See 'wp help <command>' for more information on a specific command. - -Global parameters: -EOB - ); - - self::show_synopsis(); - } - - private static function show_synopsis() { - $max_len = 0; - - $lines = array(); + function get_extra_markdown() { + $binding = array(); foreach ( \WP_CLI::$configurator->get_spec() as $key => $details ) { if ( false === $details['runtime'] ) @@ -54,23 +27,18 @@ private static function show_synopsis() { if ( isset( $details['deprecated'] ) ) continue; - $synopsis = ( true === $details['runtime'] ) - ? "--[no-]$key" - : "--$key" . $details['runtime']; - - $cur_len = strlen( $synopsis ); + if ( true === $details['runtime'] ) + $synopsis = "--[no-]$key"; + else + $synopsis = "--$key" . $details['runtime']; - if ( $max_len < $cur_len ) - $max_len = $cur_len; - - $lines[] = array( $synopsis, $details['desc'] ); + $binding['parameters'][] = array( + 'synopsis' => $synopsis, + 'desc' => $details['desc'] + ); } - foreach ( $lines as $line ) { - list( $synopsis, $desc ) = $line; - - \WP_CLI::line( sprintf( ' %s %s', str_pad( $synopsis, $max_len ), $desc ) ); - } + return Utils\mustache_render( 'man-params.mustache', $binding ); } function find_subcommand( &$args ) { diff --git a/php/WP_CLI/Dispatcher/Subcommand.php b/php/WP_CLI/Dispatcher/Subcommand.php index 55d27f925e..3203ef9d42 100644 --- a/php/WP_CLI/Dispatcher/Subcommand.php +++ b/php/WP_CLI/Dispatcher/Subcommand.php @@ -14,17 +14,26 @@ class Subcommand extends CompositeCommand { function __construct( $parent, $name, $docparser, $when_invoked ) { $this->when_invoked = $when_invoked; + $this->synopsis = $docparser->get_synopsis(); $this->alias = $docparser->get_tag( 'alias' ); parent::__construct( $parent, $name, $docparser ); } + function get_synopsis() { + return $this->synopsis; + } + function get_alias() { return $this->alias; } function show_usage( $prefix = 'usage: ' ) { - \WP_CLI::line( $prefix . get_full_synopsis( $this ) ); + \WP_CLI::line( sprintf( "%s%s %s", + $prefix, + implode( ' ', get_path( $this ) ), + $this->get_synopsis() + ) ); } private function validate_args( $args, &$assoc_args ) { diff --git a/php/WP_CLI/Runner.php b/php/WP_CLI/Runner.php index d484558651..87fee00127 100644 --- a/php/WP_CLI/Runner.php +++ b/php/WP_CLI/Runner.php @@ -231,11 +231,11 @@ private static function back_compat_conversions( $args, $assoc_args ) { unset( $assoc_args['json'] ); } - // --{version|info} -> _sys {version|info} + // --{version|info} -> cli {version|info} if ( empty( $args ) ) { foreach ( array( 'version', 'info' ) as $key ) { if ( isset( $assoc_args[ $key ] ) ) { - $args = array( '_sys', $key ); + $args = array( 'cli', $key ); break; } } @@ -299,8 +299,10 @@ public function before_wp_load() { $this->init_colorization(); $this->init_logger(); - if ( !empty( $this->arguments ) ) - Utils\load_command( $this->arguments[0] ); + if ( empty( $this->arguments ) ) + $this->arguments[] = 'help'; + + Utils\load_command( $this->arguments[0] ); if ( isset( $this->config['require'] ) ) { foreach ( $this->config['require'] as $path ) { diff --git a/php/class-wp-cli.php b/php/class-wp-cli.php index 9f928a481f..1c94a5872a 100644 --- a/php/class-wp-cli.php +++ b/php/class-wp-cli.php @@ -22,10 +22,7 @@ class WP_CLI { * Initialize WP_CLI static variables. */ static function init() { - self::add_man_dir( - WP_CLI_ROOT . "/man", - WP_CLI_ROOT . "/man-src" - ); + self::add_man_dir( null, WP_CLI_ROOT . "/man-src" ); self::$configurator = new WP_CLI\Configurator( WP_CLI_ROOT . '/php/config-spec.php' ); self::$root = new Dispatcher\RootCommand; @@ -79,8 +76,8 @@ static function add_command( $name, $class ) { self::$root->add_subcommand( $name, $command ); } - static function add_man_dir( $dest_dir, $src_dir ) { - self::$man_dirs[ $dest_dir ] = $src_dir; + static function add_man_dir( $deprecated = null, $src_dir ) { + self::$man_dirs[] = $src_dir; } static function get_man_dirs() { diff --git a/php/commands/_sys.php b/php/commands/cli.php similarity index 90% rename from php/commands/_sys.php rename to php/commands/cli.php index fefbc22316..b371c23147 100644 --- a/php/commands/_sys.php +++ b/php/commands/cli.php @@ -4,9 +4,11 @@ \WP_CLI\Utils; /** + * Get information about WP-CLI itself. + * * @when before_wp_load */ -class Sys_Command extends WP_CLI_Command { +class CLI_Command extends WP_CLI_Command { private function command_to_array( $command ) { $dump = array( @@ -55,5 +57,5 @@ function cmd_dump() { } } -WP_CLI::add_command( '_sys', 'Sys_Command' ); +WP_CLI::add_command( 'cli', 'CLI_Command' ); diff --git a/php/commands/help.php b/php/commands/help.php index a15ecc2234..d1b2cc9456 100644 --- a/php/commands/help.php +++ b/php/commands/help.php @@ -8,13 +8,15 @@ class Help_Command extends WP_CLI_Command { /** * Get help on a certain topic. * - * @synopsis [<command>] [--gen] + * @synopsis [<command>] */ function __invoke( $args, $assoc_args ) { - if ( isset( $assoc_args['gen'] ) ) - $this->generate( $args ); - else - $this->show( $args ); + $command = self::find_subcommand( $args ); + + if ( $command ) { + self::show_help( $command ); + exit; + } // WordPress is already loaded, so there's no chance we'll find the command if ( function_exists( 'add_filter' ) ) { @@ -32,143 +34,64 @@ private static function find_subcommand( $args ) { return $command; } - private function show( $args ) { - if ( self::maybe_show_manpage( $args ) ) { - exit; - } + private static function show_help( $command ) { + $out = self::get_initial_markdown( $command ); - $command = self::find_subcommand( $args ); + $out .= $command->get_extra_markdown(); - if ( $command ) { - $command->show_usage(); - exit; - } - } + // section headers + $out = preg_replace( '/^## ([A-Z ]+)/m', '%9\1%n', $out ); - private function generate( $args ) { - if ( '' === exec( 'which ronn' ) ) { - WP_CLI::error( '`ronn` executable not found.' ); - } + // old-style options + $out = preg_replace( '/\n\* `(.+)`([^\n]*):\n\n/', "\n\t\\1\\2\n\t\t", $out ); - $command = self::find_subcommand( $args ); - - if ( $command ) { - foreach ( WP_CLI::get_man_dirs() as $dest_dir => $src_dir ) { - self::_generate( $src_dir, $dest_dir, $command ); - } - exit; - } - } + $out = str_replace( "\t", ' ', $out ); - private static function maybe_show_manpage( $args ) { - $man_file = self::get_file_name( $args ); - - foreach ( \WP_CLI::get_man_dirs() as $dest_dir => $_ ) { - $man_path = "$dest_dir/" . $man_file; - - if ( is_readable( $man_path ) ) { - \WP_CLI::launch( "man $man_path" ); - return true; - } - } - - return false; + echo WP_CLI::colorize( $out ); } - private static function _generate( $src_dir, $dest_dir, $command ) { - $cmd_path = Dispatcher\get_path( $command ); - array_shift( $cmd_path ); // discard 'wp' - - $src_path = "$src_dir/" . self::get_src_file_name( $cmd_path ); - $dest_path = "$dest_dir/" . self::get_file_name( $cmd_path ); - - self::call_ronn( self::get_markdown( $src_path, $command ), $dest_path ); - - if ( $command->has_subcommands() ) { - foreach ( $command->get_subcommands() as $subcommand ) { - self::_generate( $src_dir, $dest_dir, $subcommand ); - } - } - } - - // returns a file descriptor or false - private static function get_markdown( $doc_path, $command ) { - if ( !file_exists( $doc_path ) ) - return false; - - $fd = fopen( "php://temp", "rw" ); - - self::add_initial_markdown( $fd, $command ); - - fwrite( $fd, file_get_contents( $doc_path ) ); - - if ( 0 === ftell( $fd ) ) - return false; - - fseek( $fd, 0 ); - - return $fd; - } - - private static function add_initial_markdown( $fd, $command ) { - $path = Dispatcher\get_path( $command ); + private static function get_initial_markdown( $command ) { + $name = implode( ' ', Dispatcher\get_path( $command ) ); $binding = array( - 'name_m' => implode( '-', $path ), + 'name' => $name, 'shortdesc' => $command->get_shortdesc(), ); - $synopsis = Dispatcher\get_full_synopsis( $command, true ); - - $synopsis = str_replace( '_', '\_', $synopsis ); - $synopsis = str_replace( array( '<', '>' ), '_', $synopsis ); - - $binding['synopsis'] = $synopsis; - - if ( !$binding['shortdesc'] ) { - $name_s = implode( ' ', $path ); - \WP_CLI::warning( "No shortdesc for $name_s" ); - } + $binding['synopsis'] = "$name " . $command->get_synopsis(); if ( $command->has_subcommands() ) { - foreach ( $command->get_subcommands() as $subcommand ) { - $binding['has-subcommands']['subcommands'][] = array( - 'name' => $subcommand->get_name(), - 'desc' => $subcommand->get_shortdesc(), - ); - } + $binding['has-subcommands']['subcommands'] = self::render_subcommands( $command ); } - fwrite( $fd, Utils\mustache_render( 'man.mustache', $binding ) ); + return Utils\mustache_render( 'man.mustache', $binding ); } - private static function call_ronn( $markdown, $dest ) { - if ( !$markdown ) - return; - - $descriptorspec = array( - 0 => $markdown, - 1 => array( 'file', $dest, 'w' ), - 2 => STDERR - ); - - $cmd = "ronn --date=2012-01-01 --roff --manual='WP-CLI'"; + private static function render_subcommands( $command ) { + $subcommands = array(); + foreach ( $command->get_subcommands() as $subcommand ) { + $subcommands[ $subcommand->get_name() ] = $subcommand->get_shortdesc(); + } - $r = proc_close( proc_open( $cmd, $descriptorspec, $pipes ) ); + $max_len = self::get_max_len( array_keys( $subcommands ) ); - $roff = file_get_contents( $dest ); - $roff = str_replace( ' "January 2012"', '', $roff ); - file_put_contents( $dest, $roff ); + $lines = array(); + foreach ( $subcommands as $name => $desc ) { + $lines[] = str_pad( $name, $max_len ) . "\t\t\t" . $desc; + } - \WP_CLI::log( "generated " . basename( $dest ) ); + return $lines; } - private static function get_file_name( $args ) { - return implode( '-', $args ) . '.1'; - } + private static function get_max_len( $strings ) { + $max_len = 0; + foreach ( $strings as $str ) { + $len = strlen( $str ); + if ( $len > $max_len ) + $max_len = $len; + } - private static function get_src_file_name( $args ) { - return implode( '-', $args ) . '.txt'; + return $max_len; } } diff --git a/php/dispatcher.php b/php/dispatcher.php index 45903834f3..8157d21b6b 100644 --- a/php/dispatcher.php +++ b/php/dispatcher.php @@ -12,31 +12,3 @@ function get_path( $command ) { return $path; } -function get_full_synopsis( $command, $validate = false ) { - $subcommands = $command->get_subcommands(); - - if ( empty( $subcommands ) ) { - $synopsis = $command->get_synopsis(); - - if ( $validate ) { - $tokens = \WP_CLI\SynopsisParser::parse( $synopsis ); - - foreach ( $tokens as $token ) { - if ( 'unknown' == $token['type'] ) { - \WP_CLI::warning( sprintf( - "Invalid token '%s' in synopsis for '%s'", - $token['token'], $full_name - ) ); - } - } - } - - $full_name = implode( ' ', get_path( $command ) ); - - return "$full_name $synopsis"; - } else { - return implode( "\n\n", array_map( __FUNCTION__, - $subcommands ) ); - } -} - diff --git a/templates/man-params.mustache b/templates/man-params.mustache new file mode 100644 index 0000000000..2d3383f57f --- /dev/null +++ b/templates/man-params.mustache @@ -0,0 +1,8 @@ +## GLOBAL PARAMETERS + +{{#parameters}} + {{{synopsis}}} + {{desc}} + +{{/parameters}} +Run 'wp help <subcommand>' to get more information on a specific command. diff --git a/templates/man.mustache b/templates/man.mustache index 61a99bcfcb..6767c83d87 100644 --- a/templates/man.mustache +++ b/templates/man.mustache @@ -1,17 +1,20 @@ -{{name_m}}(1) -- {{shortdesc}} -==== +## NAME + + {{{name}}} + +## DESCRIPTION + + {{{shortdesc}}} ## SYNOPSIS -{{synopsis}} + {{{synopsis}}} {{#has-subcommands}} ## SUBCOMMANDS {{#subcommands}} -* `{{name}}`: - - {{desc}} - + {{{.}}} {{/subcommands}} + {{/has-subcommands}}