Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MKFS.S3QL(1)			     S3QL			  MKFS.S3QL(1)

NAME
       mkfs.s3ql - Create an S3QL file system

SYNOPSIS
	  mkfs.s3ql [options] <storage url>

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  mkfs.s3ql command creates a	new file system	in the location	speci-
       fied by storage url. The	storage	url depends on	the  backend  that  is
       used.  The  S3QL	 User's	Guide should be	consulted for a	description of
       the available backends.

       Unless you have specified the --plain option, mkfs.s3ql will ask	you to
       enter  an  encryption  password.	This password will not be read from an
       authentication file specified with the --authfile option	to prevent ac-
       cidental	creation of an encrypted file system.

OPTIONS
       The mkfs.s3ql command accepts the following options.

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

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

	  --debug-modules _modules_
		 Activate debugging output from	specified modules (use	commas
		 to separate multiple modules).	Debug messages will be written
		 to the	target specified by the	--log option.

	  --debug
		 Activate debugging output from	all S3QL modules.  Debug  mes-
		 sages	will  be  written to the target	specified by the --log
		 option.

	  --quiet
		 be really quiet

	  --backend-options _options_
		 Backend specific options (separate by	commas).  See  backend
		 documentation for available options.

	  --version
		 just print program version and	exit

	  -L _name_
		 Filesystem label

	  --max-obj-size _size_
		 Maximum  size	of  storage  objects in	KiB. Files bigger than
		 this will be spread over  multiple  objects  in  the  storage
		 backend. Default: 10240 KiB.

	  --plain
		 Create	unencrypted file system.

	  --force
		 Overwrite any existing	data.

EXIT CODES
       mkfs.s3ql may terminate with the	following exit codes:

       0      Everything went well.

       1      An unexpected error occured. This	may indicate a bug in the pro-
	      gram.

       2      Invalid command line argument.

       3      Invalid backend option.

       11     No such backend.

       12     Authentication file has insecure permissions.

       13     Unable to	parse proxy settings.

       14     Invalid credentials (Authentication failed).

       15     No permission to access backend (Authorization denied).

       16     Invalid storage URL, specified location does not exist in	 back-
	      end.

       19     Unable to	connect	to backend, can't resolve hostname.

       45     Unable to	access cache directory.

SEE ALSO
       The S3QL	homepage is at https://bitbucket.org/nikratio/s3ql/.

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

COPYRIGHT
       A(C) 2008 Nikolaus Rath <Nikolaus@rath.org>

2.21			       October 28, 2016			  MKFS.S3QL(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXIT CODES | SEE ALSO | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=mkfs.s3ql&sektion=1&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help