xsitecopy.sgml

站点映像程序

<!-- LinuxDoc file was created by LyX 0.12 (C) 1995-1998 by <lee> Tue Mar 16 16:30:16 1999
 -->
<!-- Export filter v0.6 by Pascal Andre/Bernhard Iselborn-->

<!doctype linuxdoc system>

<article>

<title>XSitecopy
<author>Lee Mallabone &lt;[e-mail]&gt;
<toc>
<sect>Requirements
<p>

Gtk+ &gt;= 1.1.15, Gnome-libs &gt;= 0.99.8, libpthreads, and all the pre-requisites
 of those libraries.
<sect>Installation
<p>

To compile from the source distribution, change into the source directory
 and run:
<verb>./configure --enable-gnomefe
</verb>
<verb>make
</verb>
<verb>make install  (become root first) 
</verb>

To install from a binary rpm, change directory to the location of your
 freshly downloaded rpm and type the following, (substituting i386 for whatever
 architecture you are running on, and VERSION for the version you've acquired):
<verb>rpm -iv sitecopy-VERSION-1.i386.rpm
</verb>

To rebuild a binary rpm from a source rpm, do the following:
<verb>rpm --rebuild sitecopy-VERSION-1.src.rpm
</verb>

This will place a binary rpm in /usr/src/redhat/RPMS/i386/ which can be
 installed as above.
<sect>Usage
<p>

Once installed, you should find a shortcut to XSitecopy in the Internet
 section of your gnome system menu. If you are not running GNOME as your desktop
 environment, simply type xsitecopy into an xterm.
<sect1>Quick-Start
<p>

If you've never used sitecopy before, you should take a look at the README
 file that comes with the distribution. When you run xsitecopy for the first
 time, it will set up 2 things in your home directory; a configuration file
 where your site definitions are stored, and a storage directory where it will
 place (relatively small) configuration files to keep track of the files you
 add, change, move or delete on the local copies of your websites.

To create sites, click <bf>New site </bf>. You will be asked various details, and
 appropriate defaults will be setup.

If your remote site does not yet hold any of your local files, click on
 the <bf>Initialize</bf> button, and answer yes to the pop-up question. Ensure you are
 connected to the network your FTP/WebDAV server is on, and then click Update.
 A dialog box will appear, prompting you to click Begin to start the file transfers.
 Do so, and depending upon the size of your site, some time later the dialog
 will report that the update is complete, and if there were any errors, a
 button will appear to let you view a list of them.

If your local site is already the same as your remote site, you should
 then click <bf>Catch-up </bf>and answer yes to the pop-up question.

<sect>The Main Interface
<p>

At the top is the menu. At the moment, all you can do from the menu is
 exactly the same as from the toolbar. You can use the buttons in this bar to
 perform operations on your website(s). It can also be used to create &amp;
 delete sites, as well as get further help.

The main area below the toolbar is split into 2. On the left is a tree
 view. This shows the title of each site as an entry in the tree.

If you expand these items, the files that are related to the selected site
 will be shown. Clicking on a file brings up information about that file in
 the right side of the window.

<sect1>Sites
<p>
If you click on a site, the details and attributes of that site will be displayed in the main area of the program. These are divided into what are hopefully logical sections. Each section is separated by a frame, described below.
</p>
<sect2>Server Details
<p>
<itemize>
<item><bf>Hostname</bf> is the name of your remote web server. For example, ftp.geocities.com.</item>
<item><bf>Protocol</bf> determines the method that sitecopy uses to transfer
your files. This is <bf>totally</bf> dependant upon whether or not you would normally upload files to your website using FTP, or whether you are using a WebDAV server. You should choose the protocol accordingly. Note:- If xsitecopy has been compiled without WebDAV support, FTP will be the only option here.</item>

<item><bf>Username</bf> - the name you normally use to login when uploading files. If this is incorrect, you will receive errors when trying to upload your files.</item>

<item><bf>Password</bf> - the password required in order to login to the remote server. This will appear as asterisks on the screen.</item>
</itemize>
</p>
<sect2>Update Attributes
<p>
<itemize>
<item><bf>Delete remote file if local is deleted</bf>. If this is not checked, then any local files that are deleted will be forgotten about. Selecting this option will force sitecopy to delete anything that is deleted on the local copy of the remote site.
</item>
<item><bf>Move remote file if local is moved</bf>. When not checked, sitecopy will
not bother to check if a file has been moved locally, when it appears to be
deleted. If you wish all local file moves to be mirrored on the remote site,
ensure this option is checked.
</item>
<item><bf>Use passive mode FTP</bf>, should only be unchecked if you actually
<bf>know</bf> you want it unchecked.</item>
<item><bf>When uploading changed files, first delete them</bf>. This option should
not be checked by default. If you find that your FTP server has trouble
dealing with over-writing files, then this option will force sitecopy to
first delete a changed file remotely, before uploading the newer local copy.
</item>
</itemize>
</p>

<sect2>Statistics
<p>Provides a short summary of the changes (if any) to the local site, since
the last update was performed.</p>

<sect2>Locations
<p>
<itemize>
<item><bf>Directory for local files</bf>, is an absolute path in your file system. It
should be the root directory <bf>of your website</bf> that resides on your
local filesystem (or over NFS).
</item>
<item><bf>Directory for remote files</bf>, is the directory that all files will be
uploaded <bf>into</bf>. It must exist on the remote site for a successful
update to be completed. The directory must either have a / prefix if it is
an absolute path, or a ~/ prefix if it is relative to your remote login
directory.
</item>
<item>
<bf>Root URL of the remote site</bf>, is a non-essential field, that can be used to
generate a "recent changes" web page. Currently, (as of version 0.6.10), this
is only possible manually, using the changes.awk script provided with the
distribution. However, integrated report generating is a planned feature.
</item>
</itemize>
</p>

<sect2>File attributes
<p><itemize>
<item>
<bf>Permissions mode</bf>, can be one of Ignore All, Executables Only, or Maintain
For All. These options force XSitecopy to either ignore permissions of
uploaded files, maintain them for files with the execute bit set locally, or ensure
ALL remote files have the same permission bits as the local site,
respectively.
</item>
<item><bf>Symbolic links</bf>, can be treated in various ways. Follow all, will tell
XSitecopy to upload the file (or directory?) that any symbolic links point to.
Ignore links, tells XSitecopy not to care if it encounters a symbolic link
on the local site. Maintain all, will attempt to create symbolic links on
the remote site, if this is supported by the selected protocol.
</item>
</itemize>
</p>

<sect2>Advanced
<p>
Chances are that while you're editing html locally, things like backup files
will get created. While useful, it's likely you don't want them uploaded to
your remote web site. The excludes section allows you to specify regular
expressions. Any files on the local site matching these expressions will be
ignored by XSitecopy.</p>
<p>For example my excludes consist of:</p>
<p>
<itemize>
<item>*.bak</item>
<item>core</item>
<item>oldweb</item>
</itemize>
</p>
<p>because I don't want any backups or core dumps uploaded. I also have a
sub-directory on my local site called 'oldweb' which I keep for nostalgic
purposes only. This is not uploaded by specifying it as 'an exclude'.
</p>

<sect>The Menus
<sect1>File

<sect2>New
<p>This will start the site creation wizard. This wizard will take you through the step-by-step process required to give XSitecopy details about a website you wish to upload using XSitecopy. When you click "apply" the program may appear to freeze over for a number of seconds (or longer on large sites). This is currently normal, while XSitecopy processes the local files for the new site.

<sect2>Open
<p>Prompts you for the filename of a valid sitecopy configuration file. (rc file). If you specify a valid one, the sites that the file defines will be loaded into XSitecopy.
<sect2>Save sites
<p>Saves your site definitions file to the default configuration file.
<sect2>Save sites As...
<p>Will prompt you for a filename, and then save your site definitions
to the file given.
<sect2>Delete this site
<p>Asks for confirmation as to whether you wish to delete the
selected site or not. If you do, it will.
<sect2>Quit
<p>
Select this to exit the program. If your site definitions have not been
saved, you will be prompted to save them.
<sect1>Operations
<p>
<sect2>Initialise site
<p>This will make xsitecopy think that there are <bf>no</bf> files on the
remote site. This should be used to upload new files, or if you decide to
change remote servers.
<sect2>Catchup site
<p>This will force xsitecopy to assume that the remote site is identical to
your local copy. Useful for starting new sites that are already online, or
if you accidentally initialise a site.
<sect2>Fetch site listing
<p>This will make xsitecopy connect to the remote site and attempt to
determine what files are there. This is useful if your configuration files
have become corrupted, and your local-remote sites are in an inconsistent
state. It is also required if you wish to perform a resynchronization on
your local site. </p>
<p>This feature is currently work in progress, so has been disabled for this release.
<sect2>Resynchronize site
<p>Expected by 0.8.0.
<sect2>Update site
<p>This will produce a dialog box. Once you are ready to connect to the
remote site, hit <bf>Begin</bf> and xsitecopy will attempt to make a
connection. Once one has been established, the operations required
to synchronize the remote site with the local one will be committed.
Progress indicators display the percentage completed of each operation.
<sect2>Update ALL sites
<p>This will perform the above updates, for every site that requires one.
Expected by 0.9.0.
<p>

<sect1>Reports
<sect2>Required updates
<p>This displays a short report (depending upon how many sites you have
defined), simply stating which sites require an update.
<sect2>Site web-report
<p>This creates a report of all modifications of the selected site, and
displays them in your web browser. The browser use depends entirely upon how
your gnome-url settings have been configured. (see gnome control-center for
more info).<p>
NOTE:- This feature is currently a complete hack that requires about 5
things all of which are not likely to hold on a system different to my own.
A wide range of report options will be created as soon as sitecopy has reached a 1.0 state.
<sect2>Print site info
<p>Not currently implemented.

<sect1>Settings
<sect2>Preferences
<p>This allows you to set various things. Or at least it will do as soon as
I write it. :o)

<sect1>Backup
<sect2>Backup files status
<p>The state of your files on the remote site is actually stored in a file
on the local hard drive. If this file was to become corrupted, then the
state would normally have to be initialized, or "caught up". This gives you
an alternate option.
<sect2>Restore files status
<p>If you have a made a backup of your files' state information, this gives
you the option to restore it.
<sect2>Backup site definitions
<p>Saves a backup of your 'rcfile' - the file XSitecopy uses to store the
site definitions.
<sect2>Restore site definitions
<p>
If you have previously backed up your site configurations, this will restore
them.

<sect1>Help
<sect2>About
<p>Short dialog about the program.
<sect2>XSitecopy Manual
<p>Should bring up this online manual.

<sect>Troubleshooting
<p><bf>Do NOT run xsitecopy as root</bf>. My experience has shown that for
some reason all the sanity tests that determine (for example) whether a site
is selected when you click certain buttons, just fail inexplicably.
<p>Once a new site has been created, the site's "statistics" seem to usually
be wrong. Restarting the program seems to correct that. I *think* this is now fixed, but if you still encounter the problem, please let me know.

Every other reported problem &amp; solution will go here.
<sect>Todo
<p>
<itemize>
<item>More, cleaner methods of reporting changes to sites.
<item>Re-synchronize mode.
<item>Preferences dialog
<item>Output of reports to printers. (use of gnome-print perhaps).
<item>Fetch-list from remote site GUI implementation.
<item>Clean up some of the saved-notsaved code
<item>Gnome panel applet for one-click updates.
<item>Proper update/resynch cancellation - currently the update will
continue regardless of whether or not the dialog is open.
</itemize>

<sect>Known Bugs
<p>
<itemize>
<item>The tree view will only go one level deep - because of the way it is
generated any sub-directories of directories will still appear on the site's
top level.
<item>XSitecopy scales really badly at the moment; even worse than sitecopy does, so I'll try and improve that in the future.
<!--<item>When adding exclude fields, (and presumably name mappings) to a site
definition, these do not seem to actually take effect until xsitecopy is
restarted.-->
</itemize>

</article>