lukechilds
/
easyengine
mirror of https://github.com/lukechilds/easyengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

update man page

old-stable
harshadyeola 11 years ago
parent
3cb15648fc
commit
d7b77dd4ab
1 changed files with 162 additions and 42 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 204
      docs/man/ee.8

204
docs/man/ee.8
View File

@ -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
.B EasyEngine (ee)
\- Manage Nginx Based Websites.
.SH SYNOPSIS
ee [ version | info | help ]
ee [ version | help | info | stack | site | debug | update ]
.TP
ee system [ install | remove | purge ]
ee stack [ install | remove | purge ] [ nginx | php | mysql | postfix | adminer | phpmyadmin | wpcli | utils ]
.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
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
EasyEngine is the collection of shell scripts that provides automation for the web-server
.br
After ee kindly press tab key to view all arguments.
installation, site creation, services debugging & monitoring.
.SH OPTIONS
.TP
.B version
@ -28,100 +40,205 @@ ee site info - Diplay given website details like enable, disable. weboot and log
.br
Display easyengine (ee) help.
.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
Install Nginx PHP5 MySQL Postfix System Packages.
Start services NGINX, PHP5-FPM, MySQL, Postfix.
.TP
.B remove
.B stop
.br
Remove Nginx PHP5 MySQL Postfix System Packages.
Stop services NGINX, PHP5-FPM, MySQL, Postfix.
.TP
.B purge
.B reload
.br
Purge Nginx PHP5 MySQL Postfix System Packages.
Reload services NGINX, PHP5-FPM, MySQL, Postfix.
.TP
.B list
.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
/etc/nginx/sites-available to /etc/nginx/sites-enabled/.
.TP
.B disable [ example.com ]
.br
Disable site by Destroying softlink with site file in
.br
List Nginx Website.
/etc/nginx/sites-available to /etc/nginx/sites-enabled/.
.TP
.B show
.B edit [ example.com ]
.br
Show Nginx configuration for website.
Edit NGINX configuration of site.
.TP
.B create
.B create [ example.com ] [ --html | --php | --mysql | --wp | --w3tc |--wpfc ]
.br
Create HTML, PHP, MySQL and Wordpress website.
Create new site according to given options. If no options provided
.br
create static site with html only.
.TP
.B enable
.B delete [ example.com ] [--no-prompt ] [ --db | --files ]
.br
Enable website.
Delete site i.e webroot, database, ad configuration permenantly.
.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
all services, else debug only service provided with argument. Stop
.br
Disable website.
Debugging if used with --stop argument.
.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
services, else debug only service provided with argument. Stop Debugging
.br
Delete HTML, PHP, MySQL and WordPress website.
if used with --stop argument.
.SH ARGUMENTS
.TP
.B --html
.B -i
.br
setup intractive mode while used with debug.
.TP
.B --nginx
.br
Create a HTML website.
used with ee debug command. used to start or stop nginx debugging.
.TP
.B --php
.br
Create a PHP website.
used with ee debug command. used to start or stop php debugging.
.TP
.B --mysql
.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
.B --wp
.br
Create a WordPress Website.
used with ee debug command. used to start or stop wordpress site debugging.
.TP
.B --wpsubdir
.B --start
.br
Create a Wordpress Multisite with Sub Directories Setup.
used with ee debug command. used to stop debugging.
.TP
.B --wpsubdomain
.B --stop
.br
used with ee debug command. used to stop debugging.
.TP
.B --html
.br
Create a Wordpress Multisite with Sub Domains Setup.
Create a HTML website.
.TP
.B --php
.br
Create a PHP website.
.TP
.B --all
.B --mysql
.br
If uses with ee system, its install, remove or purge Nginx PHP5 MySQL Postfix System Packages.
Create a PHP+MySQL website.
.TP
.B --wp
.br
If uses with ee site delete, its delete Database, Webroot and Nginx configuration.
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
.TP
.B --db
.br
Delete website database.
Delete website database.
.br
.TP
.B --files
.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
.TP
.B --basic
.br
Create WordPress website without cache.
Create WordPress website without cache.
.TP
.B --w3tc
.br
Install and activate Nginx-helper and W3 Total Cache plugin.
Install and activate Nginx-helper and W3 Total Cache plugin.
.TP
.B --wpsc
.br
Install and activate Nginx-helper and WP Super Cache plugin.
Install and activate Nginx-helper and WP Super Cache plugin.
.TP
.B --wpfc
.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
.br
/etc/easyengine/ee.conf
@ -137,6 +254,9 @@ Report bugs at <http://github.com/rtCamp/easyengine/issues/>
.br
.B Manish
.I \<Manish.Songirkar@rtcamp.com\>
.br
.B Harshad
.I \<harshad.yeola@rtcamp.com>
.SH "SEE ALSO"
.br
EE:

Write Preview
Loading…
Cancel
Save