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