zuluCrypt  5.7.1
About: zuluCrypt is a simple but feature rich solution for hard drives encryption. It can manage PLAIN dm-crypt, LUKS, TrueCrypt and VeraCrypt encrypted volumes.
  Fossies Dox: zuluCrypt-5.7.1.tar.xz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

help.c
Go to the documentation of this file.
1 /*
2  *
3  * Copyright ( c ) 2011-2015
4  * name : Francis Banyikwa
5  * email: mhogomchungu@gmail.com
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 2 of the License, or
9  * ( at your option ) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #include "includes.h"
21 #include <stdio.h>
22 #include <libintl.h>
23 
24 /*
25  * The string is broken up to remove a compiler warning that says:
26  * warning: string length ‘XXX’ is greater than the length ‘509’ ISO C90 compilers are required to support
27  */
28 
29 void zuluCryptEXEHelp( void )
30 {
31  const char * help1 ;
32  const char * help2 ;
33  const char * help3 ;
34  const char * help4 ;
35  const char * help5 ;
36  const char * help6 ;
37  const char * help7 ;
38  const char * help8 ;
39  const char * help9 ;
40  const char * help10;
41  const char * help11;
42  const char * help12;
43  const char * help13;
44 
45  help1 = gettext( "\
46  usage: zuluCrypt-cli < operation > < options specific to the operation >\n\
47  meaning of symbols:\n\
48  <> = required option\n\
49  [] = optional argument\n\
50  * = default option\n\
51  | = alternatives for the same option\n\
52  {} = not allowed option\n\
53  \n\
54  zuluCrypt-cli -E <d> <e> <p|f|h>\n\
55  zuluCrypt-cli -D <d> <e> <p|f|h>\n\
56  zuluCrypt-cli -o <d> <m> [-e] <p|f|h>\n\
57  zuluCrypt-cli -O <d> {-m} [-e] <p|f|h>\n" ) ;
58 
59  help2 = gettext( "\
60  zuluCrypt-cli -q <d>\n\
61  zuluCrypt-cli -i <d>\n\
62  zuluCrypt-cli -c <d> <p|f|h> [ktzg]\n\
63  zuluCrypt-cli -r <d> <p|f|h> \n\
64  zuluCrypt-cli -a <d> <<y|u> <l|n>>|<h>\n\
65  zuluCrypt-cli -b <d>\n\
66  zuluCrypt-cli -w <d> d argument must be something like: UUID=\"2468d6a7-9a71-4312-8bd9-662f982fade5\" ( or without quotes )\n\
67  zuluCrypt-cli -P <d> d device must be mapper path at /dev/mapper/\n\
68  zuluCrypt-cli -X <d>\n\
69  zuluCrypt-cli -J <d>\n" ) ;
70 
71  help3 = gettext( "\
72  zuluCrypt-cli -R <d> <f>\n\
73  zuluCrypt-cli -B <d> <f>\n\
74  zuluCrypt-cli -A\n\
75  zuluCrypt-cli -S\n\
76  zuluCrypt-cli -N\n\
77  examples:\n\
78  create volume: zuluCrypt-cli -c -d /dev/sdc1 -z ext4 -t luks -p xxx\n\
79  open volume : zuluCrypt-cli -o -d /dev/sdc1 -m sdc1 -e ro -p xxx\n\
80  close volume ; zuluCrypt-cli -q -d /dev/sdc1\n\
81  remove key ; zuluCrypt-cli -r -d /dev/sdc1 -p xxx\n\
82  add key : zuluCrypt-cli -a -d /dev/sdc1 -y xxx -l yyy\n" ) ;
83 
84  help4 = gettext( "\
85  get device path from mapper : zuluCrypt-cli -P -d /dev/mapper/zuluCrypt-sdc1\n\
86  check if partition with UUID is present : zuluCrypt-cli -w -d UUID=\"d2d210b8-0b1f-419f-9172-9d509ea9af0c\"\n\
87  operation list\n\n\
88  --test run a test program\n\
89  -c create an encrypted volume\n\
90  -o open and encrypted volume\n\
91  -O open an encrypted volume but do not mount it( -m therefore not needed )\n\
92  -q close an opened encrypted volume\n\
93  -r remove a key from luks volume\n" ) ;
94 
95  help5 = gettext( "\
96  -i check if a device contain a luks volume\n\
97  -s check if a device is opened and print its properties if it is\n\
98  -b show status of each slot of luks volume.\"0\"=empty,\"1\"=occupied,\"2\"=invalid slot,\"3\"=last occupied\n\
99  -A print the list of all partitions on the system\n\
100  -N print a list of non system partitions on the system( partitions with no active entries in /etc/fstab and /etc/crypttab\n" ) ;
101 
102  help6 = gettext( "\
103  -T print a detailed list of mounted partitions.Must be used with -A or -S or -N\n\
104  -Z print a detailed list of unmounted partitions.Must be used with -A or -S or -N\n\
105  -S print a list of system partitions on the system( partitions with active entries in /etc/fstab and /etc/crypttab\n\
106  -w check if UUID matches UUID of any partition\n\
107  -P get device path from mapper( located at /dev/mapper )\n" ) ;
108 
109  help7 = gettext( "\
110  -L print a list of all opened volumes and their mount point.The list is not formatted\n\
111  -X open a device pointed by argument -d and write random data to it hiding data previously written to device\n\
112  -W check if a device is a truecrypt device or not,required argument are -p or -f\n\
113  -U print UUID of a given device,required argument: -d\n\
114  -H compare a header on a luks device to a backup header,required arg: -d and -f\n" ) ;
115 
116  help8 = gettext( "\
117  -M create a publicly accessible \"mirror\" of the mount point in \"/run/media/public/\" from the original\n\
118  created in \"/run/media/private/$USER/\"\n\
119  -a add a key to luks volume\n\
120  -F path to truecrypt multiple keyfiles.Keyfiles are separated by \":\" character\n" ) ;
121 
122  help9 = gettext( "\
123  -J create a plain mapper owned by the user who run the command on a device pointed by argument -d\n\
124  -B create a luks or truecrypt header backup\n\
125  -R restore a luks or truecrypt header on a device from backup\n\
126  \n\
127  options that goes with above operations:\n\
128  -G module name to use to get a passphrase to open a volume\n " ) ;
129 
130  help10 = gettext( "\
131  -k do not ask for confirmation when doing dangerous operations\n\
132  -d path to a file or partition with encrypted volume\n\
133  -m path component to be added to mount point prefix(/run/media/private/$USER)\n\
134  -z file system type installed(ext2,ext3,ext4* etc)\n\
135  -t type of volume (plain/luks*/tcrypt/vcrypt)\n\
136  -g options to use when creating a volume,see man page for more info\n\
137  -h get passphrase interactively\n\
138  -p passphrase \n" ) ;
139 
140  help11 = gettext( "\
141  -f path to keyfile or luks header backup\n\
142  -y passphrase already in the volume(required by -a if -u is absent and -h is also absent)\n\
143  -n path to keyfile with a passphrase to be added (required by -a if -l is absent and -h is also absent)\n" );
144 
145  help12 = gettext( "\
146  -u path to keyfile with passphrase already in the volume(required by -a if -y is absent and -h is also absent)\n\
147  truecrypt hidden volume passphrase from keyfile when used with -c\n\
148  -l passphrase to be added(required by -a if -n is absent and -h is also absent)\n\
149  truecrypt hidden volume passphrase when used with -c\n" ) ;
150  help13 = gettext( "\
151  -e mode for opening volumes(ro*/rw) when used with -o/-O. path to destination file when used with -E/-D\n\
152  -e mode for managing a truecrypt header when used with -B/-R.Options can be \"fde\" for volumes that use whole disk\n\
153  encryption,\"sys\" for a windows system volume.The volume is assumed to be a normal one when the option is not set\n" ) ;
154 
155  printf( "%s%s%s%s%s%s%s%s%s%s%s%s%s\n",help1,help2,help3,help4,help5,help6,help7,help8,help9,help10,help11,help12,help13 ) ;
156 }
zuluCryptEXEHelp
void zuluCryptEXEHelp(void)
Definition: help.c:29
includes.h