about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README74
1 files changed, 71 insertions, 3 deletions
diff --git a/README b/README
index 1520341..82ab261 100644
--- a/README
+++ b/README
@@ -1,10 +1,78 @@
-                               _________
-
+                               ━━━━━━━━━
                                   LEO
 
                                 Andinus
-                               _________
+                               ━━━━━━━━━
+
+
+Table of Contents
+─────────────────
+
+1 Documentation
+.. 1.1 archive
+.. 1.2 help
+.. 1.3 removed
+..... 1.3.1 sync functions
 
 
 Leo is a program to run my personal scripts. You might not find them
 useful, these were previously shell scripts that I rewrote in Perl.
+
+• Website: [https://andinus.nand.sh/leo]
+• Source: [https://git.tilde.institute/andinus/leo]
+• Source (mirror): [https://github.com/andinus/leo]
+
+
+1 Documentation
+═══════════════
+
+  There is a main dispatch table (`%dispatch') which has all the
+  functions.
+
+
+1.1 archive
+───────────
+
+  `archive' creates tar(1) files from a pre-defined list.
+  `%archive_dispatch' contains that list.
+
+  For example, `documents' will archive `$ENV{HOME}/documents' to
+  `/tmp/archive/documents_$ymd.tar' where `$ymd' is current date in
+  `YYYY-MM-DD' format.
+  ┌────
+  │ my %archive_dispatch = (
+  │     "documents" => sub {
+  │         tar_create("/tmp/archive/documents_$ymd.tar",
+  │                    "-C", "$ENV{HOME}/documents", ".");
+  │     },
+  │     ...
+  │ )
+  └────
+
+  I use this to quickly archive some of my files & copy them to another
+  computer as a backup.
+
+  There is no encryption or compression but it can be added directly to
+  `tar_create' function. I plan to add some encryption later. Currently
+  I store them locally (offline) so it's not required.
+
+
+1.2 help
+────────
+
+  Running just `leo' will print help. There is help message for
+  functions too, run `leo <function>' to print their help message. For
+  example, `leo archive' will print `archive''s help message.
+
+
+1.3 removed
+───────────
+
+  This contains the list of functions that were removed.
+
+
+1.3.1 sync functions
+╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
+
+  There were sync functions, they synced some of my files to remote
+  servers. I replaced it with simple `sh' scripts instead.
#n2'>2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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