%META:TOPICINFO{author="TWikiContributor" date="1288503248" format="1.1" version="1"}%
---+!! Disk Usage TWiki Plugin
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/DiskUsagePlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/DiskUsagePluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div>
%SHORTDESCRIPTION%

---++ Syntax Rules

%<nop>LOGSIZES%

%LOGSIZES%

%<nop>QUOTA%
%QUOTA%

%<nop>DISKUSAGE%
%DISKUSAGE%

%<nop>DISKUSAGE{web="Sandbox"}%
%DISKUSAGE{web="Sandbox"}%

---++ <nop>%TOPIC% Global Settings

   * One line description, shown in the Text Formatting Rules topic: 
      * Set SHORTDESCRIPTION = Show the disk usage for the current web 
   * Whether you want debug output
      * Set DEBUG = 0

---++ Plugin Installation Instructions

__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

   * Download the ZIP file from twiki.org (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   * Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section.
   * Test if the plugin is correctly installed:
   * see whether the %<nop>DISKUSAGE% directive is expanded above

---++ Future development possibilities

It could be improved on considerably. e.g.

   * One possibility is to install it in the TWiki web and use an include like <nop>WebChanges does
   * This could be called <nop>WebDiskUsage or used on a page called <nop>WebStatus
   * It should allow specification of topic and web. Currently it works only for the current web

---++ Plugin Info

|  Plugin Author: | TWiki:Main.MartinCleaver |
|  Copyright: | &copy; 2004 Martin Cleaver, %BR% &copy; 2004-2010 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2010-10-30 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2010-10-30: | TWikibug:Item6530: Doc fixes |
|  2004-03-11: | Initial release - Martin Cleaver |
|  CPAN Dependencies: | none |
|  Other Dependencies: | /usr/bin/du |
|  Perl Version: | 5.005 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %SYSTEMWEB%.TWikiPreferences, %SYSTEMWEB%.TWikiPlugins
