Disk Usage TWiki Plugin

Syntax Rules

%LOGSIZES%

%LOGSIZES%

%QUOTA% %QUOTA%

%DISKUSAGE% %DISKUSAGE%

%DISKUSAGE{web="Sandbox"}% %DISKUSAGE{web="Sandbox"}%

DiskUsagePlugin 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 DiskUsagePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/DiskUsagePlugin.txt	Plugin topic
  lib/TWiki/Plugins/DiskUsagePlugin.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 %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 WebChanges does
• This could be called WebDiskUsage or used on a page called 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:	© 2004 Martin Cleaver, © 2004-2010 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2010-10-30
Change History:
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/DiskUsagePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/DiskUsagePluginDev

Related Topics: TWikiPreferences, TWikiPlugins