From 5b4c8da6cd5acc6a31ec6ae137cf643057d784fc Mon Sep 17 00:00:00 2001 From: Mitesh Shah Date: Thu, 26 Sep 2013 20:41:30 +0530 Subject: [PATCH] Version 1.0 --- etc/bash_completion.d/ee | 2 +- install.sh | 3 ++ man/ee.8 | 89 +++++++++++++++++++++++++++++++++++++++ usr/local/sbin/easyengine | 7 ++- 4 files changed, 99 insertions(+), 2 deletions(-) create mode 100644 man/ee.8 diff --git a/etc/bash_completion.d/ee b/etc/bash_completion.d/ee index 1d4d0124..d2f76af7 100644 --- a/etc/bash_completion.d/ee +++ b/etc/bash_completion.d/ee @@ -18,7 +18,7 @@ EEAUTO() # List Of Suggested Words easyengine|ee) - COMPREPLY=( $(compgen -W "system site" -- $CURRENT) ) + COMPREPLY=( $(compgen -W "help system site" -- $CURRENT) ) return 0 ;; diff --git a/install.sh b/install.sh index fccaf448..afad838c 100644 --- a/install.sh +++ b/install.sh @@ -150,6 +150,9 @@ cp -a /tmp/easyengine/usr/share/easyengine/* /usr/share/easyengine/ &>> /dev/nul # EE Command cp -a /tmp/easyengine/usr/local/sbin/easyengine /usr/local/sbin/ &>> /dev/null || OwnError "Unable To Copy EasyEngine Command" +# EE Man Pages +cp -a /tmp/easyengine/man/ee.8 /usr/share/man/man8/ &>> /dev/null || OwnError "Unable To Copy EasyEngine Man Pages" + # Change Permission For EE chmod 750 /usr/local/sbin/easyengine || OwnError "Unable To Change EasyEngine Command Permission" diff --git a/man/ee.8 b/man/ee.8 new file mode 100644 index 00000000..454289f8 --- /dev/null +++ b/man/ee.8 @@ -0,0 +1,89 @@ +.TH EE 8 "v\ 1.0" "Thu, September 26, 2013" "EasyEngine" +.SH NAME +.B ee +\- Manage Nginx Based Websites. +.SH SYNOPSIS +ee help +.TP +ee site [ create | delete | disable | enable | list | listall | show ] +.TP +ee system [ info| install | remove | purge ] +.br +.SH DESCRIPTION +EasyEngine (EE) is a shell script to help site administrators manage nginx-based websites. +.br +.SH OPTIONS +.TP +.B create +.br +Create HTML, PHP and WordPress Websites +.TP +.B delete +.br +Delete HTML, PHP and WordPress Websites +.TP +.B disable +.br +Disable Website +.TP +.B enable +.br +Enable Website +.TP +.B list +.br +List Enabled Websites +.TP +.B listall +.br +List All Websites +.TP +.B show +.br +Show Nginx Configuration For Website +.TP +.B info +.br +Information About Nginx And PHP +.TP +.B install +.br +Install Nginx PHP5 MySQL Postfix System Packages +.TP +.B remove +.br +Remove Nginx PHP5 MySQL Postfix System Packages +.TP +.B purge +.br +Purge Nginx PHP5 MySQL Postfix System Packages +.SH EXAMPLES +.br +Please visit: http://rtcamp.com/easyengine/docs/ +.P +.SH VERSION +.B ee (EasyEngine) +version 1.0 +.SH "SEE ALSO" +.br +.TP +EE: +.I http://rtcamp.com/easyengine +.br +.TP +FAQ: +.I http://rtcamp.com/easyengine/faq/ +.br +.TP +DOCS: +.I http://rtcamp.com/easyengine/docs/ +.SH AUTHOR +.br +.B rtCamp Team +.I \ +.br +.B Mitesh Shah +.I \ +.br +.B Manish +.I \ \ No newline at end of file diff --git a/usr/local/sbin/easyengine b/usr/local/sbin/easyengine index 65b2c47e..ba3b0118 100755 --- a/usr/local/sbin/easyengine +++ b/usr/local/sbin/easyengine @@ -912,11 +912,16 @@ REMOVENGINXCONF() } +# Easy Engine Help +if [ "$1" = "help" ] || [ "$1" = "--help" ] +then + # Display Man Pages + man ee # Easy Engine System Settings -if [ "$1" = "system" ] +elif [ "$1" = "system" ] then