================================
OpenFTPD MANUAL: THE NUKE SYSTEM
================================

The nuke command was done to give siteops the possibility to remove all
credits given for uploaded files in a  directory and mark this directory 
as "nuked". Unlike the SITE DEL command the credits are removed from the
original uploader of the file.

The syntax of the nuke command is SITE NUKE <directory> <factor> <reason>.

The factor is muliplicated with the earned credits of an user and not
with the filesize. So if someone with a ratio of 1:3 (limit=33) uploaded
100 mb he gets 300 mb credits and if you nuke this directory with factor 1
those 300 mb are removed. If you use higher factors you'll remove more
credits than the user got for his upload. (Used for punishment)

You have an unnuke command to undo a nuke. SITE UNNUKE <directory> <reason>.
The original nuke factor is read from the log file so you don't have to
enter them again.

After a nuke, a human readable log file called "nuke.log" is created in the 
nuked directory, this is used for unnuke by the scripts and for informations 
about the nuke.

After a nuke or unnuke the message files msg/nuke or msg/unnuke are shown
or executed. By default an sitebot announce script is started from there. 
You can configure the irc output in the format files "msg/irc/nuke", 
"msg/irc/nukee", "msg/irc/unnuke" and "msg/irc/unnukee".

To nuke you first need nuke permissions all siteops are allowed to nuke
by default, all other users need the R_NUKE flag you can set this with
SITE USER CHANGE <user> RIGHTS+=R_NUKE (use - instead of + to revoke the 
right) or with the much easier commands SITE ADDNUKER <username> and 
SITE DELUSER <username>.

You can set 3 nuke related variables in the section config files 
(for example etc/sections/default.cfg)

  nukeprefix     = a string that will be added before the dirname on nuke
  empty_nuke     = the size in mb that will be removed on empty dir nukes
  del_empty_nuke = delete empty and nuked directories (yes/no)

--- EOF ---
