1=pod
2
3=cut
4
5Copyright (c) 2003-2004, Valient Gough <vgough@pobox.com>
6All rights reserved.
7
8EncFS is free software; you can distribute it and/or modify it under the terms
9of the GNU General Public License (GPL), as published by the Free Software
10Foundation; either version 2 of the License, or (at your option) any later
11version.
12
13=head1 NAME
14
15encfsctl - administrative tool for working with EncFS filesystems
16
17=head1 SYNOPSIS
18
19B<encfsctl> [I<command> I<command_args>]
20
21B<encfsctl> [info] I<rootdir>
22
23B<encfsctl> passwd I<rootdir>
24
25B<encfsctl> showcruft I<rootdir>
26
27B<encfsctl> decode [--extpass=prog] I<rootdir> [encoded name ...]
28
29B<encfsctl> encode [--extpass=prog] I<rootdir> [plaintext name ...]
30
31B<encfsctl> cat [--extpass=prog] [--reverse] I<rootdir> <(cipher|plain) filename>
32
33=head1 DESCRIPTION
34
35B<encfsctl> is an administrative tool for working with EncFS filesystems.  It
36is capable of changing the user supplied password, displaying basic information
37about an encrypted volume, and other related operations.
38
39=head1 COMMANDS
40
41=over 4
42
43=item B<info>
44
45Display basic information about the filesystem.  Takes a single argument,
46I<rootdir>, which is the root directory of the encrypted filesystem.  The
47filesystem need not be mounted.  B<Info> is also the default command if only a
48root directory is provided on the command line.
49
50=item B<passwd>
51
52Allows changing the password of the encrypted filesystem.  The user will be
53prompted for the existing password and the new password.
54
55=item B<showcruft>
56
57Recursively search through the entire volume and display all files which are
58not decodable (only checks filename encoding, not block MAC headers).  This
59might be useful for cleanup in case you've made use of features which create
60files which are not decodable under the primary key.
61
62=item B<decode>
63
64Allows you to specify an encoded name on the command line, and displays
65decoded version.  This is mostly useful for debugging, as debug messages always
66display encrypted filenames (to avoid leaking sensitive data through the debug
67channels).  So this command provides a way to decode the filenames.
68
69The B<--extpass> option can be used to specify the program which returns the
70password - just like with encfs.
71
72If no names are specified on the command line, then a list of filenames will be
73read from stdin and decoded.
74
75=item B<encode>
76
77Allows you to specify a filename on the command line, and displays its
78encoded version. This is useful if e.g. you are taking a backup of an
79encrypted directory and would like to exclude some files.
80
81The B<--extpass> option can be used to specify the program which returns the
82password - just like with encfs.
83
84If no names are specified on the command line, then a list of filenames
85will be read from stdin and encoded.
86
87=item B<cat>
88
89Decodes and B<cat>s the content of an encrypted file.  The filename can be
90given in a plain or ciphered form.  With B<--reverse> The file content will
91instead be encrypted.
92
93=back
94
95=head1 EXAMPLES
96
97Show information about an encrypted filesystem:
98
99 % encfsctl info ~/.crypt
100
101 Version 5 configuration; created by EncFS 1.1 (revision 20040504)
102 Filesystem cipher: "ssl/aes" , version 2:1:1
103 Filename encoding: "nameio/block" , version 3:0:1
104 Key Size: 192 bits
105 Block Size: 512 bytes
106 Each file contains 8 byte header with unique IV data.
107 Filesname encoded using IV chaining mode.
108
109=head1 DISCLAIMER
110
111This library is distributed in the hope that it will be useful, but WITHOUT ANY
112WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
113PARTICULAR PURPOSE.  Please refer to the "COPYING" file distributed with
114B<encfs> for complete details.
115
116=head1 AUTHORS
117
118B<EncFS> was written by B<< Valient Gough <vgough@pobox.com> >>.
119
120=head1 SEE ALSO
121
122encfs(1)
123