Browse Source

update man page

old-stable
harshadyeola 10 years ago
parent
commit
d7b77dd4ab
  1. 204
      docs/man/ee.8

204
docs/man/ee.8

@ -1,17 +1,29 @@
.TH ee 8 "easyengine version: 1.1.0" "January 15, 2014" "easyengine" .TH ee 8 "easyengine version: 2.0.0" "July 11, 2014" "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 | info | help ] ee [ version | help | info | stack | site | debug | update ]
.TP .TP
ee system [ install | remove | purge ] ee stack [ install | remove | purge ] [ nginx | php | mysql | postfix | adminer | phpmyadmin | wpcli | utils ]
.TP .TP
ee site [ list | show | info | create | enable | disable | delete ] ee stack [ status | start | stop | reload | restart ]
.TP
ee site [ list | info | show | enable | disable | edit ] [ example.com ]
.TP
ee site create example.com [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]]
.TP
ee site delete example.com [--db | --files | --all | --no-prompt ]
.TP
ee debug [ -i | --nginx | --rewrite | --php | --fpm | --mysql ] [ --stop ]
.TP
ee debug example.com [ -i | --nginx | --rewrite | --wp ] [--stop ]
.SH DESCRIPTION .SH DESCRIPTION
EasyEngine (ee) is a linux shell-script to manage your WordPress-Nginx websites on an Ubuntu server. EasyEngine aka ee is the opensource project developed with the purpose to automate web-server configuration.
.br .br
After ee kindly press tab key to view all arguments. EasyEngine is the collection of shell scripts that provides automation for the web-server
.br
installation, site creation, services debugging & monitoring.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B version .B version
@ -28,100 +40,205 @@ ee site info - Diplay given website details like enable, disable. weboot and log
.br .br
Display easyengine (ee) help. Display easyengine (ee) help.
.TP .TP
.B install .B stack
.TP
.B install [ nginx | php | mysql | postfix | adminer | phpmyadmin | wpcli | utils ]
.br
Install Nginx PHP5 MySQL Postfix stack Packages if not used with
.br
any options.Installs specific package if used with option.
.TP
.B remove [ nginx | php | mysql | postfix | adminer | phpmyadmin | wpcli | utils ]
.br
Remove Nginx PHP5 MySQL Postfix stack Packages if not used with
.br
any options. Remove specific package if used with option.
.TP
.B purge [ nginx | php | mysql | postfix | adminer | phpmyadmin | wpcli | utils ]
.br
Purge Nginx PHP5 MySQL Postfix stack Packages if not used with any
.br
options.Purge specific package if used with option.
.TP
.B status
.br
Display status of NGINX, PHP5-FPM, MySQL, Postfix services.
.TP
.B start
.br .br
Install Nginx PHP5 MySQL Postfix System Packages. Start services NGINX, PHP5-FPM, MySQL, Postfix.
.TP .TP
.B remove .B stop
.br .br
Remove Nginx PHP5 MySQL Postfix System Packages. Stop services NGINX, PHP5-FPM, MySQL, Postfix.
.TP .TP
.B purge .B reload
.br
Reload services NGINX, PHP5-FPM, MySQL, Postfix.
.TP
.B restart
.br
Restart services NGINX, PHP5-FPM, MySQL, Postfix.
.TP
.B site
.br
.TP
.B list [ enable | available ]
.br
Lists all available sites from /etc/nginx/sites-enabled/
.br
by default & enable argument. Display sites list from
.br
/etc/nginx/sites-available/ if used with available option.
.TP
.B info [ example.com ]
.br
prints information about site such as access log, error log
.br
location and type of site.
.TP
.B show [ example.com ]
.br
Display NGINX configuration of site.
.TP
.B enable [ example.com ]
.br
Enable site by creating softlink with site file in
.br .br
Purge Nginx PHP5 MySQL Postfix System Packages. /etc/nginx/sites-available to /etc/nginx/sites-enabled/.
.TP .TP
.B list .B disable [ example.com ]
.br .br
List Nginx Website. Disable site by Destroying softlink with site file in
.br
/etc/nginx/sites-available to /etc/nginx/sites-enabled/.
.TP .TP
.B show .B edit [ example.com ]
.br .br
Show Nginx configuration for website. Edit NGINX configuration of site.
.TP .TP
.B create .B create [ example.com ] [ --html | --php | --mysql | --wp | --w3tc |--wpfc ]
.br
Create new site according to given options. If no options provided
.br .br
Create HTML, PHP, MySQL and Wordpress website. create static site with html only.
.TP .TP
.B enable .B delete [ example.com ] [--no-prompt ] [ --db | --files ]
.br .br
Enable website. Delete site i.e webroot, database, ad configuration permenantly.
.TP .TP
.B disable .B debug [ -i | --nginx | --php | --mysql | --rewrite | --fpm ] [ --start | --stop ]
.br
Starts server level debugging. If used without arguments starts debugging
.br .br
Disable website. all services, else debug only service provided with argument. Stop
.br
Debugging if used with --stop argument.
.TP .TP
.B delete .B debug example.com [ -i | --nginx | --rewrite | --wp ] [ --start | --stop ]
.br
Starts site level debugging. If used without arguments starts debugging all
.br .br
Delete HTML, PHP, MySQL and WordPress website. services, else debug only service provided with argument. Stop Debugging
.br
if used with --stop argument.
.SH ARGUMENTS .SH ARGUMENTS
.TP .TP
.B --html .B -i
.br
setup intractive mode while used with debug.
.TP
.B --nginx
.br .br
Create a HTML website. used with ee debug command. used to start or stop nginx debugging.
.TP .TP
.B --php .B --php
.br .br
Create a PHP website. used with ee debug command. used to start or stop php debugging.
.TP .TP
.B --mysql .B --mysql
.br .br
Create a PHP+MySQL website. used with ee debug command. used to start or stop mysql debugging.
.TP
.B --rewrite
.br
used with ee debug command. used to start or stop nginx rewrite rules debugging.
.TP
.B --fpm
.br
used with ee debug command. used to start or stop fpm debugging.
.TP .TP
.B --wp .B --wp
.br .br
Create a WordPress Website. used with ee debug command. used to start or stop wordpress site debugging.
.TP .TP
.B --wpsubdir .B --start
.br .br
Create a Wordpress Multisite with Sub Directories Setup. used with ee debug command. used to stop debugging.
.TP .TP
.B --wpsubdomain .B --stop
.br .br
Create a Wordpress Multisite with Sub Domains Setup. used with ee debug command. used to stop debugging.
.TP
.B --html
.br .br
Create a HTML website.
.TP .TP
.B --all .B --php
.br .br
If uses with ee system, its install, remove or purge Nginx PHP5 MySQL Postfix System Packages. Create a PHP website.
.TP
.B --mysql
.br .br
If uses with ee site delete, its delete Database, Webroot and Nginx configuration. Create a PHP+MySQL website.
.TP
.B --wp
.br
Create a WordPress Website.
.TP
.B --wpsubdir
.br
Create a Wordpress Multisite with Sub Directories Setup.
.TP
.B --wpsubdomain
.br
Create a Wordpress Multisite with Sub Domains Setup.
.br .br
.TP .TP
.B --db .B --db
.br .br
Delete website database. Delete website database.
.br .br
.TP .TP
.B --files .B --files
.br .br
Delete website webroot. Delete website webroot.
.br
.TP
.B --no-prompt
.br
Does not prompt for confirmation when delete command used.
.SH WORDPRESS CACHING OPTIONS .SH WORDPRESS CACHING OPTIONS
.TP .TP
.B --basic .B --basic
.br .br
Create WordPress website without cache. Create WordPress website without cache.
.TP .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.
.TP .TP
.B --wpsc .B --wpsc
.br .br
Install and activate Nginx-helper and WP Super Cache plugin. Install and activate Nginx-helper and WP Super Cache plugin.
.TP .TP
.B --wpfc .B --wpfc
.br .br
Install and activate Nginx-helper and W3 Total Cache plugin with Nginx FastCGI cache. Install and activate Nginx-helper and W3 Total Cache plugin with
.br
Nginx FastCGI cache.
.SH FILES .SH FILES
.br .br
/etc/easyengine/ee.conf /etc/easyengine/ee.conf
@ -137,6 +254,9 @@ Report bugs at <http://github.com/rtCamp/easyengine/issues/>
.br .br
.B Manish .B Manish
.I \<Manish.Songirkar@rtcamp.com\> .I \<Manish.Songirkar@rtcamp.com\>
.br
.B Harshad
.I \<harshad.yeola@rtcamp.com>
.SH "SEE ALSO" .SH "SEE ALSO"
.br .br
EE: EE:

Loading…
Cancel
Save