added README, INSTALL and LICENSE files

Tue, 05 Jul 2016 18:23:20 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Tue, 05 Jul 2016 18:23:20 +0200
changeset 240
220ea6247077
parent 239
56f91e0de57b
child 241
da7ace67deab

added README, INSTALL and LICENSE files

INSTALL file | annotate | diff | comparison | revisions
LICENSE file | annotate | diff | comparison | revisions
Makefile file | annotate | diff | comparison | revisions
README file | annotate | diff | comparison | revisions
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL	Tue Jul 05 18:23:20 2016 +0200
@@ -0,0 +1,62 @@
+Requirements
+------------
+
+In order to compile this software you need, in addition to a C compiler, the
+following libraries:
+
+libcurl
+libxml2
+openssl
+
+You can install them with the following command
+Debian/Ubuntu:
+
+    apt-get install libxml2-dev libcurl3-openssl-dev libssl-dev
+
+EL/Fedora:
+
+    yum install libxml2-devel libcurl-devel openssl-devel
+
+openSUSE:
+
+    zypper install libxml2-devel libcurl-devel libopenssl-devel
+
+Solaris:
+
+    pkg install libxml2 curl openssl
+
+
+Build instructions
+------------------
+
+When using gcc, just run
+
+    make
+
+To use a different compiler run
+
+    make CONF=<config>
+
+Available configs:
+gcc
+clang
+suncc
+osx
+mingw
+
+
+Install
+-------
+
+After a successful compilation, the binaries (dav/dav-sync) are in the
+build directory. You can install them by running
+
+    make install
+
+This installs the binaries to /usr. To install to an other location, run
+
+    make install PREFIX=/your/prefix
+
+Note: The install target doesn't work on Windows, therefore you need to install
+the two executables manually.
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE	Tue Jul 05 18:23:20 2016 +0200
@@ -0,0 +1,25 @@
+Copyright 2016 Olaf Wintermann. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+
--- a/Makefile	Mon May 23 12:12:53 2016 +0200
+++ b/Makefile	Tue Jul 05 18:23:20 2016 +0200
@@ -30,6 +30,7 @@
 #
 # available configurations:
 #   gcc
+#   clang
 #   suncc
 #   mingw
 #   osx
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Tue Jul 05 18:23:20 2016 +0200
@@ -0,0 +1,87 @@
+    DavUtils - cmd tools
+============================
+
+Introduction
+------------
+
+A collection of command line tools for accessing WebDAV server, including the
+tool dav, a general purpose WebDAV client and dav-sync, a program for
+synchronizing local files with WebDAV server. Both tools can encrypt files
+on the fly with AES.
+
+
+Installation
+------------
+
+See the file INSTALL for build and installation instructions.
+
+
+Documentation
+-------------
+
+Documentation can be found at http://davutils.sourceforge.net/docs/
+
+
+First Steps
+-----------
+
+Most dav commands expect an url, for example if you want to list all
+resources in a WebDAV collection you can do it with
+
+    $ dav list https://example.com/webdav/mycollection/
+
+A useful feature is to save your repository information in the
+$HOME/.dav/config.xml file. An easy way to do this is to use the
+interactive configuration assistent.
+
+    $ dav add-repository
+
+After you configured the repository you can access it with its name, for
+example
+
+    $ dav list myrepo
+
+You can combine the repository name with a path
+
+    $ dav list myrepo/files/
+	
+
+Support
+-------
+
+Bug reports and feature requests can be done at sourceforge. For questions
+you can use the sourceforge forum or contact me via email.
+
+https://sourceforge.net/p/davutils/tickets/
+https://sourceforge.net/p/davutils/discussion/
+
+Olaf Wintermann <olaf.wintermann@gmail.com>
+
+
+License
+-------
+
+Copyright 2016 Olaf Wintermann. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+

mercurial