aboutsummaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)Author
2017-03-28MANPAGE: reformat to GFM (github flavored markdown)Jakob Unterwurzacher
This makes it render properly on the github webinterface.
2017-03-25MANPAGE: fix alphabetical order and expand scryptn explainationJakob Unterwurzacher
2017-03-25Further explain the use of 'scryptn' parameter (#94)danim7
* Further explain the use of 'scryptn' parameter * Further explain the use of 'scryptn' parameter in MANPAGE * Use 28 as reasonable upper limit
2017-03-25README: use pre-rendered PNG logoJakob Unterwurzacher
This keeps the README working even if nuetzlich.net is unavailable. We use a PNG because github disallows embedding local SVGs.
2017-03-19MANPAGE: document "-serialize_reads"Jakob Unterwurzacher
2017-03-18benchmark: add md5sum read performance benchmarkJakob Unterwurzacher
2017-03-01CLI_ABI: smaller markdown subheadingsrfjakob
The old ones were rendered by github almost as big as the parent headings.
2017-02-26MANPAGE: document "-speed"Jakob Unterwurzacher
2017-02-26MANPAGE: document error code 12Jakob Unterwurzacher
2017-02-12Add CLI ABI documentationJakob Unterwurzacher
Closes https://github.com/rfjakob/gocryptfs/issues/77
2017-02-12Document "--" to stop option parsing in help text + man pageJakob Unterwurzacher
2017-01-29readpassword: support spaces in "-passfile" filenameJakob Unterwurzacher
...and while we are at it, also filenames starting with "-".
2017-01-26main: add "-fsname" optionJakob Unterwurzacher
As requested in https://github.com/rfjakob/gocryptfs/issues/73 .
2016-11-26performance.txt: add numbers for current gocryptfs master and encfs v1.9.1Jakob Unterwurzacher
2016-11-26benchmark.bash: double write lengthJakob Unterwurzacher
Writing 1000 128KB blocks takes only 1 second and yielded inconsistent results. With 2000, things look saner.
2016-11-25main, fusefrontend: add "-noprealloc" optionJakob Unterwurzacher
Preallocation is very slow on hdds that run btrfs. Give the user the option to disable it. This greatly speeds up small file operations but reduces the robustness against out-of-space errors. Also add the option to the man page. More info: https://github.com/rfjakob/gocryptfs/issues/63
2016-11-11MANPAGE: document ctlsockJakob Unterwurzacher
2016-11-01main: rename "-f" to "-fg"Jakob Unterwurzacher
"-f" looks too much like "--force". The old variant is still accepted for compatability.
2016-11-01MANPAGE: document -raw64Jakob Unterwurzacher
2016-11-01MANPAGE: update version field descriptionJakob Unterwurzacher
2016-11-01MANPAGE: add reverse example, move "-o" into alphabetical listJakob Unterwurzacher
People will search for "-o" alphabetically, so put it into the alphabetical option list, even if it is not a real option.
2016-11-01packakge.bash: include rendered man page in tarballJakob Unterwurzacher
2016-10-21MANPAGE: prettify plain-text formattingJakob Unterwurzacher
2016-10-16main: allow password change with -masterkeyJakob Unterwurzacher
Requested at https://github.com/rfjakob/gocryptfs/issues/28
2016-10-09Update performance.txt for v1.1 releaseJakob Unterwurzacher
2016-10-09main: add "-passfile" optionJakob Unterwurzacher
Make it easier to read the password from a file. Internally this is equivalent to "-extpass /bin/cat FILE".
2016-10-09main: also accept options at the end via "-o"Jakob Unterwurzacher
For compatability with mount(1), options are also accepted as "-o COMMA-SEPARATED-OPTIONS" at the end of the command line. For example, "-o q,zerokey" is equivalent to "-q -zerokey".
2016-10-09main: rename "-o" option to "-ko"Jakob Unterwurzacher
This prevents confusion with the "-o" options that is passed by mount(1) at the end of the command line.
2016-10-07MANPAGE: note that "-f" implies "-nosyslog"Jakob Unterwurzacher
Also explain why AES-SIV exists.
2016-10-06main: add "-nonempty" optionJakob Unterwurzacher
2016-09-26reverse: switch from GCM-SIV to AES-SIVv1.1-beta1Jakob Unterwurzacher
GCM-SIV is not yet finalized, and the reference implemenation is painfully slow at about 2 MB/s. Switch to AES-SIV.
2016-09-25reverse: add gcmsiv flag and associated testsJakob Unterwurzacher
2016-07-03XFSTESTS.md: add output from latest fuse-xfstestsJakob Unterwurzacher
fuse-xfstests is regularily rebased to xfstests master.
2016-06-26MANPAGE: note that "-plaintextnames" disables symlink encryptionJakob Unterwurzacher
This is no change in behavoir, just a clarification in the man page.
2016-06-26main: add "-o" option to enable "suid" and "dev"Jakob Unterwurzacher
Device files and suid binaries are often not needed when running gocryptfs as root. As they are potentially dangerous, let the user enable them explicitely via the new "-o" option instead of always enabling them when running as root.
2016-06-23Drop deprecated "-gcmiv128" optionJakob Unterwurzacher
The GCMIV128 feature flag is already mandatory, dropping the command line option is the final step. Completes https://github.com/rfjakob/gocryptfs/issues/29 .
2016-06-23Drop deprecated "-emenames" optionJakob Unterwurzacher
The EMENames feature flag is already mandatory, dropping the command line option is the final step.
2016-06-23Drop deprecated "-diriv" optionJakob Unterwurzacher
The DirIV feature flag is already mandatory, dropping the command line option is the final step.
2016-06-19main: drop "on-disk format" from -version output, add Go versionJakob Unterwurzacher
As v0.4 introduced ext4-style feature flags, the on-disk format version is unlinkely to change. Drop it from the version output to reduce clutter. Use "gocryptfs -version -debug" to see it. Add the Go version string because only Go 1.6 and newer have an optimized AES-GCM implementation. This will help users to understand the performance of their build.
2016-06-16Add "-ro" (read-only) flagJakob Unterwurzacher
From the man page: **-ro** : Mount the filesystem read-only Also add a test.
2016-06-08Add performance numbers for v0.11Jakob Unterwurzacher
2016-05-18Add "-allow_other" command-line optionJakob Unterwurzacher
As requested in https://github.com/rfjakob/gocryptfs/issues/26 , this adds the option to allow other users to access the filesystem.
2016-05-12prefer_openssl: add amd64 constraintJakob Unterwurzacher
Optimized assembly versions for Go GCM are only available on amd64.
2016-05-12prefer_openssl: autodetect whether to use OpenSSL or Go GCMJakob Unterwurzacher
Go GCM is faster than OpenSSL if the CPU has AES instructions and you are running Go 1.6+. The "-openssl" option now defaults to "auto". "gocryptfs -debug -version" displays the result of the autodetection. See https://github.com/rfjakob/gocryptfs/issues/23 for details and benchmarks.
2016-05-04stupidgcm: completely replace spacemonkeygo/opensslJakob Unterwurzacher
2016-04-17Update manpage with "longnames" option, explain feature flag optionsJakob Unterwurzacher
2016-04-10Update readme.md and performance.txt for v0.9Jakob Unterwurzacher
2016-04-10Add v0.9-rc2 performance numbersJakob Unterwurzacher
2016-01-31Add new "-wpanic" option and enable it for the automated testsJakob Unterwurzacher
2016-01-24Update MANPAGE with new optionsJakob Unterwurzacher