.. -*- mode: rst -*-


=================================
The :program:`s3qlrm` command
=================================

Synopsis
========

::

   s3qlrm [options] <directory>
  
Description
===========

.. include:: ../include/about.rst

The |command| command recursively deletes files and directories on an
S3QL file system. Although |command| is faster than using e.g.
:command:`rm -r``, the main reason for its existence is that it allows
you to delete immutable trees (which can be created with
:program:`s3qllock`) as well.

Be warned that there is no additional confirmation. The directory will
be removed entirely and immediately.

|command| can only be called by the user that mounted the file system
and (if the file system was mounted with :cmdopt:`--allow-other` or
:cmdopt:`--allow-root`) the root user. This limitation might be
removed in the future (see `issue 155
<http://code.google.com/p/s3ql/issues/detail?id=155>`_).
  

Options
=======

The |command| command accepts the following options:

.. pipeinclude:: python ../../bin/s3qlrm --help
   :start-after: show this help message and exit

.. include:: ../include/postman.rst

.. |command| replace:: :command:`s3qlrm` 

