[Zope3-checkins] CVS: Zope3/src/zope/fssync - zbundle.txt:1.1

[Fred L. Drake, Jr.]

Update of /cvs-repository/Zope3/src/zope/fssync
In directory cvs.zope.org:/tmp/cvs-serv1290

Added Files:
	zbundle.txt 
Log Message:
very rough start at documentation for zbundle


=== Added File Zope3/src/zope/fssync/zbundle.txt ===
Name
----

**zbundle** - Zope bundle management tool


Synopsis
--------

**zbundle** [*general-options*...] *command* [*command-options*...] [*args*]


Description
-----------

The **zbundle** command is used to manage site management bundles
within a **zsync** checkout.

**create**
  Create a bundle and schedule it for addition to Zope via **zsync**.

**help**
  Display help text.

There are general options which apply to all **zbundle** commands, and
specific options which apply to individual commands.  General options
must be specified between the **zbundle** command name and the specific
command, while options for specific commands must be supplied after
the name of the specific command.


General Options
~~~~~~~~~~~~~~~

The following general options are supported.  These must be specified
between the name **zbundle** and the name of the specific command being
run.

-h, --help
  Display help text


The **zbundle create** Command
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Synopsis
++++++++

**create** PATH [SOURCE]

Description
+++++++++++

XXX

Options
+++++++

-f FACTORY, --factory FACTORY
  Specify the object factory to use for the object being added.

-t TYPE, --type TYPE           
  The type of the object to be created.  Normally only *FACTORY* needs
  to be specified.


The **zsync help** Command
~~~~~~~~~~~~~~~~~~~~~~~~~~

Synopsis
++++++++

**help** [*command* ...]

Description
+++++++++++

When used with specifying *command*, this displays general help on
using **zsync**.  When *command* is given, information about each
command list is presented.


Security Notes
--------------

- The ``@@Zope/Root`` file contains the username and password with
  which the checkout was made.  Since this will typically allow access
  with content management priviledges, this file should not be shared
  carelessly.


Files
-----

**zbundle** does not create any supplemental files beyond what
**zsync** produces.  Refer to the **zsync** documentation for details
on those files.


Reporting Bugs
--------------

Bugs in **zbundle** and the filesystem synchronization support in Zope 3
should be reported via the `Zope 3 Development Issue Collector`__, an
online reporting tool that allows you to enter reports directly into
our bug-tracking system.

.. __: http://collector.zope.org/Zope3-dev


See Also
--------

There are two interesting and directly relevant articles in the `Zope 3
wiki`:

* The |FSSYNC|_ is the initial proposal for a way to synchronize
  copies of a Zope-based website between a filesystem-based
  representation and the database backing the live site.

* Bundles are discussed in |TTWSITE|_; this gives more information on
  the motivation and goals surrounding this work.

.. |FSSYNC| replace::   Filesystem Synchronization Proposal
.. |TTWSITE| replace::  Through the Web Site Development

.. _FSSYNC:   http://dev.zope.org/Zope3/FileSystemSynchronizationProposal
.. _TTWSITE:  http://dev.zope.org/Zope3/ThroughTheWebSiteDevelopment


Copyright
---------

Copyright (c) 2003 `Zope Corporation`__ and Contributors.
All Rights Reserved.

.. __:  http://www.zope.com/

This software is subject to the provisions of the `Zope Public
License`_, Version 2.0 (ZPL).  A copy of the ZPL should accompany
this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST
INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.

.. _Zope Public License:  http://www.zope.org/Resources/ZPL