Browse Source

Update Man page

feature/refactor-php
rjdp 10 years ago
parent
commit
77f2597f72
  1. 55
      docs/ee.8
  2. 2
      ee/cli/plugins/clean.py

55
docs/ee.8

@ -1,19 +1,19 @@
.TH ee 8 "EasyEngine (ee) version: 3.0" "Feb 2,2014" "EasyEngine" .TH ee 8 "EasyEngine (ee) version: 3.3.3" "Aug 11,2015" "EasyEngine"
.SH NAME .SH NAME
.B EasyEngine (ee) .B EasyEngine (ee)
\- Manage Nginx Based Websites. \- Manage Nginx Based Websites.
.SH SYNOPSIS .SH SYNOPSIS
ee [ --version | --help | info | stack | site | debug | update ] ee [ --version | --help | info | stack | site | debug | update | clean | import_slow_log | log | secure | sync]
.TP .TP
ee stack [ install | remove | purge ] [ --web | --mail | --all | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ] ee stack [ install | remove | purge | migrate | upgrade] [ --web | --mail | --all | --nginx | --php | --mysql | --admin | --postfix | --mailscanner | --adminer | --redis | --hhvm | --phpmyadmin | --phpredisadmin | --wpcli | --utils ]
.TP .TP
ee stack [ status | start | stop | reload | restart ] ee stack [ status | start | stop | reload | restart ] [--all | --nginx | --php | --mysql | --devcot | --web | --postfix | --memcache | --redis]
.TP .TP
ee site [ list | info | show | enable | disable | edit ] [ example.com ] ee site [ list | info | show | enable | disable | edit | cd | show ] [ example.com ]
.TP .TP
ee site create example.com [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]] ee site create example.com [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--wpsc | --w3tc | --wpfc | --wpredis | --hhvm ]]
.TP .TP
ee site update example.com [ --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]] ee site update example.com [ --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--wpsc | --w3tc | --wpfc | --wpredis | --hhvm ]]
.TP .TP
ee site delete example.com [--db | --files | --all | --no-prompt | --force/-f ] ee site delete example.com [--db | --files | --all | --no-prompt | --force/-f ]
.TP .TP
@ -46,19 +46,19 @@ Display easyengine (ee) help.
.TP .TP
.B stack .B stack
.TP .TP
.B install [ --all | --web | --mail | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ] .B install [ --all | --web | --mail | --nginx | --php | --mysql | --redis | --postfix | --adminer | --phpmyadmin | --phpredismyadmin | --wpcli | --utils ]
.br .br
Install Nginx PHP5 MySQL Postfix stack Packages if not used with Install Nginx PHP5 MySQL Postfix stack Packages if not used with
.br .br
any options.Installs specific package if used with option. any options.Installs specific package if used with option.
.TP .TP
.B remove [ --all | --web | --mail | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ] .B remove [ --all | --web | --mail | --nginx | --php | --mysql | --redis | --postfix | --adminer | --phpmyadmin | --phpredismyadmin | --wpcli | --utils ]
.br .br
Remove Nginx PHP5 MySQL Postfix stack Packages if not used with Remove Nginx PHP5 MySQL Postfix stack Packages if not used with
.br .br
any options. Remove specific package if used with option. any options. Remove specific package if used with option.
.TP .TP
.B purge [ --all | --web | --mail | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ] .B purge [ --all | --web | --mail | --nginx | --php | --mysql | --redis | --postfix | --adminer | --phpmyadmin | --phpredismyadmin | --wpcli | --utils ]
.br .br
Purge Nginx PHP5 MySQL Postfix stack Packages if not used with any Purge Nginx PHP5 MySQL Postfix stack Packages if not used with any
.br .br
@ -66,23 +66,23 @@ options.Purge specific package if used with option.
.TP .TP
.B status .B status
.br .br
Display status of NGINX, PHP5-FPM, MySQL, Postfix services. Display status of NGINX, PHP5-FPM, MySQL, Postfix, Redis-Server services.
.TP .TP
.B start .B start
.br .br
Start services NGINX, PHP5-FPM, MySQL, Postfix. Start services NGINX, PHP5-FPM, MySQL, Postfix, Redis-Server.
.TP .TP
.B stop .B stop
.br .br
Stop services NGINX, PHP5-FPM, MySQL, Postfix. Stop services NGINX, PHP5-FPM, MySQL, Postfix, Redis-Server.
.TP .TP
.B reload .B reload
.br .br
Reload services NGINX, PHP5-FPM, MySQL, Postfix. Reload services NGINX, PHP5-FPM, MySQL, Postfix, Redis-Server.
.TP .TP
.B restart .B restart
.br .br
Restart services NGINX, PHP5-FPM, MySQL, Postfix. Restart services NGINX, PHP5-FPM, MySQL, Postfix, Redis-Server.
.TP .TP
.B site .B site
.br .br
@ -129,13 +129,13 @@ Disable site by Destroying softlink with site file in
.br .br
Edit NGINX configuration of site. Edit NGINX configuration of site.
.TP .TP
.B create [ example.com ] [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]] .B create [ example.com ] [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--wpsc | --w3tc | --wpfc | --wpredis | --hhvm]]
.br .br
Create new site according to given options. If no options provided Create new site according to given options. If no options provided
.br .br
create static site with html only. create static site with html only.
.TP .TP
.B update [ example.com ] [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]] .B update [ example.com ] [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [ --wpsc | --w3tc | --wpfc | --wpredis | --hhvm]]
.br .br
Update site configuration according to specified options. Update site configuration according to specified options.
.TP .TP
@ -159,13 +159,13 @@ services.Else it will debug only service provided with argument.This will Stop D
.br .br
if used with --all=off argument. if used with --all=off argument.
.TP .TP
.B secure [ --auth | --port ] .B secure [ --auth | --port | --ip ]
.br .br
Update security settings. Update security settings.
.TP .TP
.B clean [ --fastcgi | --opcache | --memcache | --all ] .B clean [ --fastcgi | --opcache | --memcache | --redis | --pagespeed | --all ]
.br .br
Clean NGINX fastCGI cache, Opcache, Memcache. Clean NGINX fastCGI cache, Opcache, Memcache, Redis cache, Pagespeed cache.
.br .br
Clean NGINX fastCGI cache if no option specified. Clean NGINX fastCGI cache if no option specified.
.SH ARGUMENTS .SH ARGUMENTS
@ -264,10 +264,6 @@ used with ee secure command. Change EasyEngine admin port 22222.
used with ee secure command. Update whitelist IP address used with ee secure command. Update whitelist IP address
.SH WORDPRESS CACHING OPTIONS .SH WORDPRESS CACHING OPTIONS
.TP .TP
.B --basic
.br
Create WordPress website without cache.
.TP
.B --w3tc .B --w3tc
.br .br
Install and activate Nginx-helper and W3 Total Cache plugin. Install and activate Nginx-helper and W3 Total Cache plugin.
@ -281,6 +277,14 @@ Install and activate Nginx-helper and WP Super Cache plugin.
Install and activate Nginx-helper and W3 Total Cache plugin with Install and activate Nginx-helper and W3 Total Cache plugin with
.br .br
Nginx FastCGI cache. Nginx FastCGI cache.
.TP
.B --wpredis
.br
Install, activate, configure Nginx-helper and Redis Object Cache Plugin, Configure NGINX for Redis Page Caching.
.TP
.B --hhvm
.br
Install, activate Nginx-helper and configure NGINX for HHVM.
.SH FILES .SH FILES
.br .br
/etc/easyengine/ee.conf /etc/easyengine/ee.conf
@ -309,6 +313,9 @@ Report bugs at <http://github.com/rtCamp/easyengine/issues/>
.B Prabuddha .B Prabuddha
.I \<prabuddha.chakraborty@rtcamp.com\> .I \<prabuddha.chakraborty@rtcamp.com\>
.br .br
.B Rajdeep Sharma
.I \<rajdeep.sharma@rtcamp.com\>
.br
.SH "SEE ALSO" .SH "SEE ALSO"
.br .br

2
ee/cli/plugins/clean.py

@ -20,7 +20,7 @@ class EECleanController(CementBaseController):
label = 'clean' label = 'clean'
stacked_on = 'base' stacked_on = 'base'
stacked_type = 'nested' stacked_type = 'nested'
description = ('Clean NGINX FastCGI cache, Opcacache, Memcache') description = ('Clean NGINX FastCGI cache, Opcacache, Memcache, Pagespeed Cache, Redis Cache')
arguments = [ arguments = [
(['--all'], (['--all'],
dict(help='Clean all cache', action='store_true')), dict(help='Clean all cache', action='store_true')),

Loading…
Cancel
Save