s3qllock(1) [debian man page]

S3QLLOCK(1)							       S3QL							       S3QLLOCK(1)

NAME

       s3qllock - Make trees on an S3QL file system immutable

SYNOPSIS

       s3qllock [options] <directory>

DESCRIPTION

       S3QL  is  a  file  system for online data storage. Before using S3QL, make sure to consult the full documentation (rather than just the man
       pages which only briefly document the available userspace commands).

       The s3qllock command makes a directory tree in an S3QL file system immutable. Immutable trees can no longer be changed in any  way  whatso-
       ever.  You can not add new files or directories and you can not change or delete existing files and directories. The only way to get rid of
       an immutable tree is to use the s3qlrm command.

       s3qllock can only be called by the user that mounted  the  file	system	and  (if  the  file  system  was  mounted  with  --allow-other	or
       --allow-root) the root user. This limitation might be removed in the future (see issue 155).

RATIONALE

       Immutability  is a feature designed for backups. Traditionally, backups have been made on external tape drives. Once a backup was made, the
       tape drive was removed and locked somewhere in a shelf. This has the great advantage that the contents of the backup  are  now  permanently
       fixed. Nothing (short of physical destruction) can change or delete files in the backup.

       In  contrast,  when  backing  up  into an online storage system like S3QL, all backups are available every time the file system is mounted.
       Nothing prevents a file in an old backup from being changed again later on. In the worst case, this may	make  your  entire  backup  system
       worthless.  Imagine  that  your	system	gets infected by a nasty virus that simply deletes all files it can find -- if the virus is active
       while the backup file system is mounted, the virus will destroy all your old backups as well!

       Even if the possibility of a malicious virus or trojan horse is excluded, being able to change a backup after it has been made is generally
       not a good idea. A common S3QL use case is to keep the file system mounted at all times and periodically create backups with rsync -a. This
       allows every user to recover her files from a backup without having to call the system administrator. However, this also allows every  user
       to accidentally change or delete files in one of the old backups.

       Making  a backup immutable protects you against all these problems.  Unless you happen to run into a virus that was specifically programmed
       to attack S3QL file systems, backups can be neither deleted nor changed after they have been made immutable.

OPTIONS

       The s3qllock command accepts the following options:

	  --debug
		 activate debugging output

	  --quiet
		 be really quiet

	  --version
		 just print program version and exit

EXIT STATUS

       s3qllock returns exit code 0 if the operation succeeded and 1 if some error occurred.

SEE ALSO

       The S3QL homepage is at http://code.google.com/p/s3ql/.

       The  full  S3QL	documentation  should  also  be  installed  somewhere  on  your  system,  common  locations  are  /usr/share/doc/s3ql	or
       /usr/local/doc/s3ql.

COPYRIGHT

       2008-2011, Nikolaus Rath

1.11.1								  August 27, 2014						       S3QLLOCK(1)

MOUNT.S3QL(1)							       S3QL							     MOUNT.S3QL(1)

NAME

       mount.s3ql - Mount an S3QL file system

SYNOPSIS

       mount.s3ql [options] <storage url> <mount point>

DESCRIPTION

       S3QL  is  a  file  system for online data storage. Before using S3QL, make sure to consult the full documentation (rather than just the man
       pages which only briefly document the available userspace commands).

       The mount.s3ql command mounts the S3QL file system stored in storage url in the directory mount point. The storage url depends on the back-
       end that is used. The S3QL User's Guide should be consulted for a description of the available backends.

OPTIONS

       The mount.s3ql command accepts the following options.

	  --log <target>
		 Write	logging  info into this file. File will be rotated when it reaches 1 MB, and at most 5 old log files will be kept. Specify
		 none to disable logging. Default: ~/.s3ql/mount.log

	  --cachedir <path>
		 Store cached data in this directory (default: ~/.s3ql)

	  --authfile <path>
		 Read authentication credentials from this file (default: ~/.s3ql/authinfo2)

	  --debug <module>
		 activate debugging output from <module>. Use all to get debug messages from all modules. This option can  be  specified  multiple
		 times.

	  --quiet
		 be really quiet

	  --ssl  Always  use  SSL connections when connecting to remote servers. For backends that allow only encrypted connections, S3QL uses SSL
		 automatically, even if this option is not set.

	  --version
		 just print program version and exit

	  --cachesize <size>
		 Cache size in kb (default: 102400 (100 MB)). Should be at least 10 times the maximum object size of the filesystem, otherwise	an
		 object may be retrieved and written several times during a single write() or read() operation.

	  --max-cache-entries <num>
		 Maximum number of entries in cache (default: 768).  Each cache entry requires one file descriptor, so if you increase this number
		 you have to make sure that your process file descriptor limit (as set with ulimit -n) is high enough  (at  least  the	number	of
		 cache entries + 100).

	  --min-obj-size <size>
		 Minimum  size	of storage objects in KB. Files smaller than this may be combined into groups that are stored as single objects in
		 the storage backend. Default: 512 KB.

	  --allow-other
		 Normally, only the user who called mount.s3ql can access the mount point. This user then also has full access to it,  independent
		 of  individual  file  permissions.  If  the --allow-other option is specified, other users can access the mount point as well and
		 individual file permissions are taken into account for all users.

	  --allow-root
		 Like --allow-other, but restrict access to the mounting user and the root user.

	  --fg	 Do not daemonize, stay in foreground

	  --single
		 Run in single threaded mode. If you don't understand this, then you don't need it.

	  --upstart
		 Stay in foreground and raise SIGSTOP once mountpoint is up.

	  --profile
		 Create profiling information. If you don't understand this, then you don't need it.

	  --compress <name>
		 Compression algorithm to use when storing new data.  Allowed values: lzma, bzip2, zlib, none.	(default: lzma)

	  --metadata-upload-interval <seconds>
		 Interval in seconds between complete metadata uploads.  Set to 0 to disable. Default: 24h.

	  --threads <no>
		 Number of parallel upload threads to use (default: auto).

	  --nfs  Enable some optimizations for exporting the file system over NFS. (default: False)

EXIT STATUS

       mount.s3ql returns exit code 0 if the operation succeeded and 1 if some error occurred.

SEE ALSO

       The S3QL homepage is at http://code.google.com/p/s3ql/.

       The  full  S3QL	documentation  should  also  be  installed  somewhere  on  your  system,  common  locations  are  /usr/share/doc/s3ql	or
       /usr/local/doc/s3ql.

COPYRIGHT

       2008-2011, Nikolaus Rath

1.11.1								  August 27, 2014						     MOUNT.S3QL(1)