about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README27
1 files changed, 24 insertions, 3 deletions
diff --git a/README b/README
index 66a474d..ad08183 100644
--- a/README
+++ b/README
@@ -9,12 +9,14 @@ Table of Contents
 ─────────────────
 
 1 Documentation
-.. 1.1 help
+.. 1.1 encrypt/sign
+.. 1.2 delete
+.. 1.3 help
 2 History
 
 
 Leo is my archival program. It creates tar(1) files from a pre-defined
-list.
+list. It can encrypt/sign files with gpg2(1).
 
 • Web-site: [https://andinus.nand.sh/leo]
 • Source: [https://git.tilde.institute/andinus/leo]
@@ -45,7 +47,26 @@ list.
   computer as a backup.
 
 
-1.1 help
+1.1 encrypt/sign
+────────────────
+
+  `encrypt_sign' handles `gpg2' related functions. It passes `--yes' by
+  default.
+
+  *Note*: `gpg2' might compress the archives depending on your config.
+   Default is to enable compression, if you don't want this then add `-z
+   0' to `@options'. `-z' specifies the compression level & 0 means no
+   compression.
+
+
+1.2 delete
+──────────
+
+  Removes the archive file after running gpg2(1). This means that either
+  `encrypt' or `sign' option must be passed.
+
+
+1.3 help
 ────────
 
   Running just `leo' will print help.
29 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278