00001 <?php 00002 // $Id: doxygen.php,v 1.27 2010/05/04 00:06:41 fl3a Exp $ 00003 00004 //This file is for doxygen documenation purposes only 00005 00006 /** 00007 * @file 00008 * Additional Doxygen documentation 00009 */ 00010 00011 /** 00012 * @mainpage 00013 * 00014 * <img src="drush_logo-black.png" alt="drush logo" title="drush logo" /> 00015 * 00016 * <strong> 00017 * <a href="http://drupal.org/project/drush_multi" style="font-weight:bold">Drush Multi</a> is an an extension to <a href="http://drupal.org/project/drush" style="font-weight:bold">drush</a> aka <a href="http://drupal.org" style="font-weight:bold">Drupal</a> Shell</a> which deals with Drupal multisites. 00018 * 00019 * Drush Multi requires drush >= v.3.0-beta1. 00020 * </strong> 00021 * 00022 * @subpage intro "Introduction" 00023 * 00024 * @subpage install "Installation" 00025 * 00026 * @subpage cmds "Commands" 00027 * 00028 * @subpage credits 00029 * 00030 * @subpage feedback 00031 * 00032 * <small> 00033 * This documentation was generated with <a href="http://doxygen.org">Doxygen</a>. 00034 * 00035 * Each of these called softwares including drush_multi itself are released under the terms of <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</a> 00036 * 00037 * Drupal is a registered trademark of <a href="http://buytaert.net">Dries Buytaert</a>. 00038 * </small> 00039 */ 00040 00041 00042 /** 00043 * @page install Installation 00044 * You can put drush_multi in a number of places: 00045 * - In a .drush folder in your HOME folder. 00046 * - Along with one of your existing modules. If your command is 00047 * related to an existing module, this is the preferred option. 00048 * - In a folder specified with the include option. 00049 * - In /path/to/drush/commands (not a "Smart Thing to Do", but it would work). 00050 * 00051 * Change / cd to one of that places above and type the following command to get the latest Version (HEAD) from cvs: 00052 * @code 00053 * cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal-contrib checkout -d drush_multi-HEAD contributions/modules/drush_multi/ 00054 * @endcode 00055 */ 00056 00057 /** 00058 * @page cmds Commands 00059 * 00060 * Drush_multi provides the following commands: 00061 * 00062 * @subpage multi_status_help "multi-status" 00063 * 00064 * An extended drush core status 00065 * 00066 * @subpage multi_create_help "multi-create" 00067 * 00068 * Creates a multisite installation 00069 * 00070 * @subpage multi_exec_help "multi-exec" 00071 * 00072 * Execute drush core commands on all sites (batch mode) 00073 * 00074 * @subpage multi_drupalupdate_help "multi-drupalupdate" 00075 * 00076 * Updates the installation if there is a new minor release available 00077 * 00078 * @subpage multi_sql_dump_help "multi-sql-dump" 00079 * 00080 * Execute a sql dump on all sites (batch mode) 00081 * 00082 * @subpage multi_nagios_help "multi-nagios" 00083 * 00084 * Command for use as nagios plugin with exit status and status message 00085 * 00086 * @subpage multi_site_help "multi-site" 00087 * 00088 * Creates a site within the installation 00089 */ 00090 00091 /** 00092 * @page credits Credits 00093 * Thanks to the mighty hundfred, friend and Bastard Operator from Hell. 00094 * 00095 * This module was sponsored by <a href="http://is-loesungen.de">ISL Individuelle System Lösungen</a>. 00096 * 00097 * Maintainer of this module is <a href="http://netzaffe.de">Florian "fl3a" Latzel</a>. 00098 */ 00099 00100 /** 00101 * @page feedback Feedback 00102 * <strong>Share your thoughts!</strong> 00103 * 00104 * Since this project is open source and mostly written in my spare time, 00105 * 00106 * i would encourage you to give me some feedback. 00107 * 00108 * <strong>You are welcome to contribute!</strong> 00109 * 00110 * For feature requests, bug reports, bugfixes, and patches please <a href="http://drupal.org/node/add/project-issue/drush_multi">create a new issue</a> at the <a href="http://drupal.org/project/issues/drush_multi?categories=All">issue queue</a> within the <a href="http://drupal.org/project/drush_multi">project page</a>. 00111 * 00112 * If you want to comtribute, please take a look at the @ref todo. 00113 */ 00114 00115 /** 00116 * @page multi_status_help "multi-status" 00117 * An extended drush core status 00118 * 00119 * The core status is extended with 00120 * 00121 * 'Site Counter', number of sites within the installation 00122 * 00123 * 'Sites', sites within the installation 00124 * 00125 * 'Prev.Installations', previous installed Drupal versions 00126 * 00127 * 'Drupal Core', Status of Drupal core 00128 * 00129 * @section Aliases 00130 * @subsection multi_status_alias_mst mst 00131 * @section Examples 00132 * @code 00133 * drush -r /path/to/drupal multi-status 00134 * @endcode 00135 * We asume that we are running drupal-6-14 with the 2 sites, default and foobar.com 00136 * and drupal-6.11, drupal-6.12 and drupal-6.13 before drupal-6.14. 00137 * @code' 00138 * PHP configuration : /etc/php5/cli/php.ini 00139 * Drupal Root : /var/www/6.x 00140 * Drupal version : 6.14 00141 * Site Path : sites/default 00142 * Site URI : http://default 00143 * Database Driver : mysqli 00144 * Database Hostname : localhost 00145 * Database Username : dbuser 00146 * Database Name : db 00147 * Database Password : dbpasswd 00148 * Database : Connected 00149 * Drupal Bootstrap : Successful 00150 * Drupal User : Anonymous 00151 * Site Counter : 2 00152 * Sites : foobar.com default 00153 * Prev.Installations: drupal-6.11 drupal-6.12 drupal-6.13 00154 * Drupal Core : Uptodate 00155 * '@endcode 00156 * If drupal-6.15 is available, in the "Drupal Core" section will display a red 00157 * @code 00158 * '6.15 available' 00159 * @endcode 00160 */ 00161 00162 /** 00163 * @page multi_create_help "multi-create" 00164 * Create a Drupal installation with the symbolic link structure as described in the \ref intro. 00165 * @section Aliases 00166 * @subsection multi_create_alias_mcr mcr 00167 * @subsection multi_create_alias_create create 00168 * @section Arguments 00169 * @subsection destination /path/to/installation 00170 * The path where the installation should be created 00171 * @subsection core Core compatibility 00172 * Core compatibility e.g. 6 for drupal 6 00173 * @section Examples 00174 * @code 00175 * drush multi-create /var/www 6 00176 * @endcode 00177 * Create a drupal 6 installation in /var/www 00178 * with creating the directories 6.x_backup, 6.x_profiles 00179 * and 6.x_sites in /var/www link them as backup, profiles and sites 00180 * into the drupal installation folder with a relative path. 00181 */ 00182 00183 /** 00184 * @page multi_exec_help "multi-exec" 00185 * Perform a drush core command on all sites (batch mode). 00186 * @section Aliases 00187 * @subsection multi_exec_alias mex 00188 * @section Arguments 00189 * @subsection multi_exec_command command 00190 * The drush command to execute. 00191 * For drush commands with blanks like 'watchdog show' 00192 * make sure to use single or double quotes. Mandatory. 00193 * @section Options 00194 * @subsection multi_exec_argument --argument 00195 * Argument to pass to drush command e.g. 'site_offline 1' 00196 * as argument for 'variable-set'. Optional. 00197 * @subsection multi_exec_option --option 00198 * Option to pass to drush command. or drush itself e.g. 00199 * '--nocolor' to suppress color highlighting on log messages. Optional. 00200 * @section Examples 00201 * @code 00202 * drush -r /path/to/drupal multi-exec cron 00203 * @endcode 00204 * Run all cron hooks on all sites in your multisite installation. 00205 * @code 00206 * drush -r /path/to/drupal multi-exec variable-set --argument='site_offine 1' --option='--nocolor' 00207 * @endcode 00208 * Put all sites in maintenance mode without using color highlighting on log messages. 00209 * @code 00210 * drush -r /path/to/drupal multi-exec updatedb 00211 * @endcode 00212 * Execute the update.php process for all sites. 00213 * @code 00214 * drush -r /path/to/drupal multi-exec cache-clear 00215 * @endcode 00216 * Flushes the cache for all sites 00217 */ 00218 00219 /** 00220 * @page multi_drupalupdate_help "multi-drupalupdate" 00221 * Update your installation if there is a new minor release available, 00222 * assuming the same structure as in the @ref intro for the installation. 00223 * 00224 * All symbolic links within the original drupal installation are detected and preserved automatically. 00225 * @see @ref symlinks for handling and preserving symbolic links. 00226 * 00227 * @section Aliases 00228 * @subsection multi_drupalupdate_alias_mdr mdr 00229 * @subsection multi_drupalupdate_alias_drupalupdate drupalupdate 00230 * @section Options 00231 * @subsection multi_drupalupdate_sql_dump_option --sql-dump 00232 * Executes 'multi sql dump' before running 'multi drupalupdate'. 00233 * 00234 * See @ref multi_sql_dump_help for usable options and details. 00235 * 00236 * @subsection multi_drupalupdate_updatedb_option --updatedb 00237 * Executes 'updatedb' after ececution of 'multi drupalupdate' via @ref multi_exec_help. 00238 * 00239 * @section Examples 00240 * @code 00241 * drush -r /path/to/drupal multi drupalupdate 00242 * @endcode 00243 * Runs a 'multi-drupalupdate'on /path/to/drupal 00244 * 00245 * @code 00246 * drush -r /path/to/drupal multi-drupalupdate --sql-dump --comment='before drupaldate' --updatedb 00247 * @endcode 00248 * Runs a 'multi-drupalupdate'on /path/to/drupal with 00249 * 00250 * making sql dumps of all sites with optional comment 'before drupalupdate' for sql dump filenames 00251 * 00252 * and execution of 'updatedb' afterwards 00253 * @note The Drupal root specified as /path/to/drupal must be a symbolic link. 00254 */ 00255 00256 /** 00257 * @page multi_sql_dump_help "multi-sql-dump" 00258 * Perform an sql dump on all sites (batch mode). 00259 * @section Aliases 00260 * @subsection multi_sql_dump_alias_msd msd 00261 * @section Options 00262 * @subsection multi_sql_dump_destination --target 00263 * Absolute Path to the directory where to store the sql dumps. 00264 * Default /tmp. 00265 * @subsection multi_sql_dump_dump_type --dump-type 00266 * Arguments: 00267 * 00268 * "full" Creates one file for all tables (default). 00269 * 00270 * "tables" Creates for each table within each database a seperate file. 00271 * 00272 * @subsection multi_sql_dump_datetime --datetime 00273 * Adds a datetime to resultfiles. (YYYY-MM-DDThh:mm) 00274 * @subsection multi_sql_dump_comment --comment 00275 * Comment for filename. May contain alphanumics, '-' and '_'. 00276 * @subsection multi_sql_dump_bzip2 --bzip2 00277 * Use bzip2 for compression of each sql dump. 00278 * @section Examples 00279 * @code 00280 * drush -r /path/to/drupal multi-sql-dump --bzip2 --comment=before-update-to-6.15 --target=$HOME/db_backups 00281 * @endcode 00282 * Run 'sql dump' on all sites with comment 00283 * 'before-update-to-6.15' as comment for each result file. 00284 * 00285 * The result files are bzip2 compressed and stored in 'db_backups' in your home dirctory. 00286 * 00287 * Dump name schema for the command as executed above. 00288 * 00289 * 'example.com_before-update-to-6.15.sql.bz2', where example.com is one of your sites. 00290 */ 00291 00292 /** 00293 * @page multi_nagios_help "multi-nagios" 00294 * For the use as nagios plugin. Print a message and returns with exit status 2 (Critical) 00295 * if updates available. 00296 * 00297 * multi_nagios could be run on the with -r /--root supplied Drupal installation 00298 * to check for core updates. 00299 * 00300 * or 00301 * 00302 * on a the with -l / --uri supplied site to check for core and module updates 00303 * 00304 * @note If there is a site at sites/default, this command runs on site basis, although you have only specified the Drupal installation. 00305 * 00306 * @section Aliases 00307 * @subsection multi_nagios_alias_mna mna 00308 * @subsection multi_nagios_alias_nagios nagios 00309 * @section Options 00310 * @subsection multi_nagios_file --file 00311 * Path to release information file, this could 00312 * be a (temp) file to avoid nrpe-socket timeouts. 00313 * It is also possible to supply path via URI, 00314 * like http://updates.drupal.org/release-history/drupal/6.x. 00315 * 00316 * @note This option could only be used to check the Drupal installation. 00317 * @section Examples 00318 * @subsection nagios_root Checking the Drupal installation for core updates 00319 * @code 00320 * drush -r /path/to/drupal multi-nagios 00321 * @endcode 00322 * We assume that drupal-6.14 is the recommended release. 00323 * With an older version, eg. drupal-6.13 we get: 00324 * @code 00325 * DRUPAL ROOT CRITICAL: drupal-6.13 @ /path/to/drupal 00326 * - drupal-6.14 (2009-09-16 21:40) available, see http://drupal.org/node/579476 for details. 00327 * @endcode 00328 * with exit status 2 00329 * 00330 * Or if we are running the recommended version: 00331 * @code 00332 * DRUPAL ROOT OK: drupal-6.14 @ /path/to/drupal/6.x is uptodate. 00333 * @endcode 00334 * with exit status 0. 00335 * 00336 * @code 00337 * drush -r /path/to/drupal multi-nagios --file=/path/to/file 00338 * @endcode 00339 * Same as above with a specified file. 00340 * 00341 * 00342 * @subsection nagios_site Checking a site on core and module updates 00343 * @code 00344 * drush -r /path/to/drupal -l example.com multi-nagios 00345 * @endcode 00346 * If there are no updates available, this will produce to following output: 00347 * @code 00348 * DRUPAL SITE OK - example.com @ /path/to/drupal/example.com: All modules are uptodate. 00349 * @endcode 00350 * 00351 * If there are available updates, it might produce the following output: 00352 * @code 00353 * DRUPAL SITE CRITICAL - example.com @ /path/to/drupal/sites/example.com: there are updates for admin_menu,drupal,image, see http://example.com/?q=admin/reports/updates for datails. 00354 * @endcode 00355 */ 00356 00357 /** 00358 * @page multi_site_help "multi-site" 00359 * Create a new site in your your multisite installation within a files, modules and themes directory. 00360 * @section Aliases 00361 * @subsection multi_nagios_site_alias_msi msi 00362 * @subsection multi_nagios_site_alias_site site 00363 * @section Arguments 00364 * @subsection multi_nagios_site_name site-name 00365 * Name of the site. Mandatory. 00366 * @section Options 00367 * @subsection multi_site_create_dirs --create-directories 00368 * Comma seperated list of aditional directories. 00369 * @section Examples 00370 * @code 00371 * drush -r /path/to/drupal multi-site example.com --create-directories=dir1,dir2,dir3 00372 * @endcode 00373 * Create the site 'example.com' within a settings.php, a 'files', 'themes', 'modules' directory 00374 * and the additional directories 'dir1', 'dir2' and 'dir3' in /path/to/drupal/sites. 00375 */ 00376 ?>
1.5.8