commands.org
... ...
@@ -18,18 +18,18 @@ title: Commands | Pluckeye
18 18
19 19
** Examples
20 20
To add an [[rules#allow][allow]] rule:
21
-#+BEGIN_EXAMPLE
22
-pluck + allow wikipedia.org
23
-#+END_EXAMPLE
21
+ #+BEGIN_SRC sh
22
+ pluck + allow wikipedia.org
23
+ #+END_SRC
24 24
25
-#+BEGIN_EXAMPLE
26
-pluck + block image/
27
-#+END_EXAMPLE
25
+ #+BEGIN_SRC sh
26
+ pluck + block image/
27
+ #+END_SRC
28 28
29 29
To enable the [[system]] feature:
30
-#+BEGIN_EXAMPLE
31
-pluck + system
32
-#+END_EXAMPLE
30
+ #+BEGIN_SRC sh
31
+ pluck + system
32
+ #+END_SRC
33 33
34 34
* - (minus)
35 35
Usage: ~pluck - [rule]~
... ...
@@ -40,19 +40,19 @@ pluck + system
40 40
41 41
** Examples
42 42
To remove an [[rules#allow][allow]] rule:
43
-#+BEGIN_EXAMPLE
44
-pluck - allow facebook.com
45
-#+END_EXAMPLE
43
+ #+BEGIN_SRC sh
44
+ pluck - allow facebook.com
45
+ #+END_SRC
46 46
47 47
To remove a [[rules#when]] rule:
48
-#+BEGIN_EXAMPLE
49
-pluck - when 8-9 allow youtube.com
50
-#+END_EXAMPLE
48
+ #+BEGIN_SRC sh
49
+ pluck - when 8-9 allow youtube.com
50
+ #+END_SRC
51 51
52 52
To disable the [[features#nhb][nhb]] feature:
53
-#+BEGIN_EXAMPLE
54
-pluck - nhb
55
-#+END_EXAMPLE
53
+ #+BEGIN_SRC sh
54
+ pluck - nhb
55
+ #+END_SRC
56 56
57 57
* abort
58 58
Usage: ~pluck abort [context]~
... ...
@@ -62,20 +62,20 @@ pluck - nhb
62 62
** Examples
63 63
In all of the following examples a rule change is entered, but the rule never comes into effect if you have a non-zero [[delay]], because the change is aborted.
64 64
65
-#+BEGIN_EXAMPLE
66
-pluck + allow wikipedia.org
67
-pluck abort
68
-#+END_EXAMPLE
65
+ #+BEGIN_SRC sh
66
+ pluck + allow wikipedia.org
67
+ pluck abort
68
+ #+END_SRC
69 69
70
-#+BEGIN_EXAMPLE
71
-pluck + allow https://example.com/foo
72
-pluck abort example.com
73
-#+END_EXAMPLE
70
+ #+BEGIN_SRC sh
71
+ pluck + allow https://example.com/foo
72
+ pluck abort example.com
73
+ #+END_SRC
74 74
75
-#+BEGIN_EXAMPLE
76
-pluck + allow example.com image/
77
-pluck abort image
78
-#+END_EXAMPLE
75
+ #+BEGIN_SRC sh
76
+ pluck + allow example.com image/
77
+ pluck abort image
78
+ #+END_SRC
79 79
80 80
* approved?
81 81
Usage: ~pluck approved?~
... ...
@@ -113,9 +113,9 @@ pluck abort image
113 113
The output you see when you run this command will depend on your Pluckeye configuration; the default configuration produces outputs similar to the ones shown here.
114 114
115 115
Input (what you type):
116
-#+BEGIN_EXAMPLE
117
-pluck eval google.com
118
-#+END_EXAMPLE
116
+ #+BEGIN_SRC sh
117
+ pluck eval google.com
118
+ #+END_SRC
119 119
120 120
Output (what the computer adds):
121 121
#+BEGIN_EXAMPLE
... ...
@@ -125,9 +125,9 @@ allow because of rule 330: allow
125 125
~eval~ says google.com is allowed, but this does not mean that all content (like images) will be visible on the website. All it means is that you should be able to visit the page. In order to determine if images will be shown, we must add ~image/~.
126 126
127 127
Input:
128
-#+BEGIN_EXAMPLE
129
-pluck eval google.com image/
130
-#+END_EXAMPLE
128
+ #+BEGIN_SRC sh
129
+ pluck eval google.com image/
130
+ #+END_SRC
131 131
132 132
Output:
133 133
#+BEGIN_EXAMPLE
... ...
@@ -143,16 +143,16 @@ block because of rule 420: block image/
143 143
All of these examples demonstrate how to create a file on your Desktop that contains your Pluckeye configuration.
144 144
145 145
*** Windows
146
-#+BEGIN_EXAMPLE
147
-cd Desktop
148
-pluck export > pluckeye-configuration.txt
149
-#+END_EXAMPLE
146
+ #+BEGIN_SRC sh
147
+ cd Desktop
148
+ pluck export > pluckeye-configuration.txt
149
+ #+END_SRC
150 150
151 151
*** Linux or Mac OS
152
-#+BEGIN_EXAMPLE
153
-cd ~/Desktop
154
-pluck export > pluckeye-configuration.txt
155
-#+END_EXAMPLE
152
+ #+BEGIN_SRC sh
153
+ cd ~/Desktop
154
+ pluck export > pluckeye-configuration.txt
155
+ #+END_SRC
156 156
157 157
* factoryreset
158 158
Usage: ~pluck factoryreset~
... ...
@@ -175,14 +175,14 @@ pluck export > pluckeye-configuration.txt
175 175
The output of this command will depend on your Pluckeye configuration; the default configuration produced the outputs shown here.
176 176
177 177
This example will give no output, since none of the rules in the default configuration contain "google.com".
178
-#+BEGIN_EXAMPLE
179
-pluck find google.com
180
-#+END_EXAMPLE
178
+ #+BEGIN_SRC sh
179
+ pluck find google.com
180
+ #+END_SRC
181 181
182 182
Input:
183
-#+BEGIN_EXAMPLE
184
-pluck find image/
185
-#+END_EXAMPLE
183
+ #+BEGIN_SRC sh
184
+ pluck find image/
185
+ #+END_SRC
186 186
187 187
Output:
188 188
#+BEGIN_EXAMPLE
... ...
@@ -226,9 +226,9 @@ Examples:
226 226
** Examples
227 227
Before running this command, first open the terminal in the directory (AKA folder) containing the pluckeye-configuration.txt file that you want to import.
228 228
229
-#+BEGIN_EXAMPLE
230
-pluck import pluckeye-configuration.txt
231
-#+END_EXAMPLE
229
+ #+BEGIN_SRC sh
230
+ pluck import pluckeye-configuration.txt
231
+ #+END_SRC
232 232
233 233
* import-allow
234 234
Usage: ~pluck import-allow [context file]~
... ...
@@ -236,9 +236,9 @@ pluck import pluckeye-configuration.txt
236 236
Similar to ~import~, but the file should contain a list of websites, pages, programs, etc. An `allow` rule will be added to your configuration for each one of these. This is equivalent to running ~pluck + allow [line]~ for every line in the context file, except that lines starting with ~#~ in the context file will be ignored.
237 237
238 238
** Examples
239
-#+BEGIN_EXAMPLE
240
-pluck import-allow good-websites.txt
241
-#+END_EXAMPLE
239
+ #+BEGIN_SRC sh
240
+ pluck import-allow good-websites.txt
241
+ #+END_SRC
242 242
243 243
In good-websites.txt, there could be:
244 244
#+BEGIN_EXAMPLE
... ...
@@ -253,9 +253,9 @@ https://youtube.com/watch
253 253
Similar to [[#import-allow][import-allow]], but all of the websites, pages, programs, etc. in the context file will be blocked.
254 254
255 255
** Examples
256
-#+BEGIN_EXAMPLE
257
-pluck import-block bad-websites.txt
258
-#+END_EXAMPLE
256
+ #+BEGIN_SRC sh
257
+ pluck import-block bad-websites.txt
258
+ #+END_SRC
259 259
260 260
* mayprove
261 261
Usage: ~pluck mayprove~
... ...
@@ -268,9 +268,9 @@ pluck import-block bad-websites.txt
268 268
Prints the [[media-types][media type]] for the specified extension.
269 269
270 270
** Examples
271
-#+BEGIN_EXAMPLE
272
-pluck mety .css
273
-#+END_EXAMPLE
271
+ #+BEGIN_SRC sh
272
+ pluck mety .css
273
+ #+END_SRC
274 274
275 275
In this case, the output would be:
276 276
#+BEGIN_EXAMPLE
... ...
@@ -306,9 +306,9 @@ pluck mety .css
306 306
307 307
** Examples
308 308
This pipeline finds all rules in your configuration that contain "example.com", replaces "allow" with "when now+5m block" in all of the rules, and then imports these new rules into your configuration. The point is to cause all content on example.com that was allowed by ~allow~ rules before to be blocked five minutes from now.
309
-#+BEGIN_EXAMPLE
310
-pluck find example.com | pluck replace allow "when now+5m block" | pluck import -
311
-#+END_EXAMPLE
309
+ #+BEGIN_SRC sh
310
+ pluck find example.com | pluck replace allow "when now+5m block" | pluck import -
311
+ #+END_SRC
312 312
313 313
* supplicate
314 314
Usage: ~pluck supplicate~
how-to-install.org
... ...
@@ -99,17 +99,17 @@ d. In the terminal window, type: =sudo ./pluckeye-linux*.installer= and press en
99 99
a. [[how-to-open-a-console-window][Open a terminal]].
100 100
101 101
b. In the terminal, extract using 7-Zip (7z).
102
- #+BEGIN_EXAMPLE
102
+ #+BEGIN_SRC sh
103 103
cd ~/Downloads
104 104
7z x pluckeye-linux-*.**.*.tar.gz
105
- #+END_EXAMPLE
105
+ #+END_SRC
106 106
107 107
(/Replace the asterisks in the example to match the file name of your downloaded Pluckeye file/.)
108 108
109 109
c. In the same terminal window, run the extracted install file.
110
- #+BEGIN_EXAMPLE
110
+ #+BEGIN_SRC sh
111 111
sudo ~/Downloads/pluckeye-linux-*.**.*.installer
112
- #+END_EXAMPLE
112
+ #+END_SRC
113 113
114 114
(/Replace the asterisks in the example to match the current version numbers as before/.)
115 115
media-types.org
... ...
@@ -18,24 +18,24 @@ title: Media Types | Pluckeye
18 18
Media types can be specified in Pluckeye [[rules]] to allow or block certain types of content. Here are some examples of [[commands]] you could use to add such rules:
19 19
20 20
To allow all images on Facebook:
21
-#+BEGIN_EXAMPLE
22
-pluck + allow facebook.com image/
23
-#+END_EXAMPLE
21
+ #+BEGIN_SRC sh
22
+ pluck + allow facebook.com image/
23
+ #+END_SRC
24 24
25 25
To allow SVG images everywhere:
26
-#+BEGIN_EXAMPLE
27
-pluck + allow image/svg
28
-#+END_EXAMPLE
26
+ #+BEGIN_SRC sh
27
+ pluck + allow image/svg
28
+ #+END_SRC
29 29
30 30
To block Adobe Flash on a particular page:
31
-#+BEGIN_EXAMPLE
32
-pluck + block https://example.com/foo.html application/x-shockwave-flash
33
-#+END_EXAMPLE
31
+ #+BEGIN_SRC sh
32
+ pluck + block https://example.com/foo.html application/x-shockwave-flash
33
+ #+END_SRC
34 34
35 35
The general format of these commands is:
36
-#+BEGIN_EXAMPLE
37
-pluck <+ / -> <rule type> [host / url / ip address / port] <media type>
38
-#+END_EXAMPLE
36
+ #+BEGIN_SRC sh
37
+ pluck <+ / -> <rule type> [host / url / ip address / port] <media type>
38
+ #+END_SRC
39 39
40 40
(See the [[rules][Rules]] page to understand what the terms in the general form mean.)
41 41
restricted-devices.org
... ...
@@ -49,9 +49,9 @@ feature:system
49 49
50 50
8. Susan runs this command on the computer in a [[how-to-open-a-console-window][console window]]:
51 51
52
-#+BEGIN_EXAMPLE
53
-pluck sync
54
-#+END_EXAMPLE
52
+ #+BEGIN_SRC sh
53
+ pluck sync
54
+ #+END_SRC
55 55
56 56
9. Susan restarts the computer.
57 57
rules.org
... ...
@@ -46,18 +46,20 @@ If you want to add a fairly simple rule, like ~allow en.wikipedia.org~, you can
46 46
Allows content from a specified website, page, or program, or allows a specific type of content. If you allow a whole website (e.g., ~pluck + allow wikipedia.org~), all resources (images, videos, etc.) on all pages on the website will be allowed, even if those resources are from a different website (unless the website that the resouces are from is blocked). For example, if your friend has a blog and you allow the blog, you will be able to watch YouTube videos they embed in their blog posts unless you block youtube.com.
47 47
48 48
*** Examples
49
-#+BEGIN_EXAMPLE
50
-pluck + allow google.com
51
-#+END_EXAMPLE
52 49
53
-#+BEGIN_EXAMPLE
54
-pluck + allow https://www.youtube.com/watch?v=AkoML0_FiV4
55
-#+END_EXAMPLE
50
+ #+BEGIN_SRC sh
51
+ pluck + allow google.com
52
+ #+END_SRC
53
+
54
+ #+BEGIN_SRC sh
55
+ pluck + allow https://www.youtube.com/watch?v=AkoML0_FiV4
56
+ #+END_SRC
56 57
57 58
[[https://en.wikipedia.org/wiki/Scalable_Vector_Graphics][SVG images]] are not taken by cameras, but are created using gemoetric shapes. As such, they are not a concern for most who wish to avoid problematic images online. To allow SVG images:
58
-#+BEGIN_EXAMPLE
59
-pluck + allow image/svg
60
-#+END_EXAMPLE
59
+
60
+ #+BEGIN_SRC sh
61
+ pluck + allow image/svg
62
+ #+END_SRC
61 63
62 64
** block
63 65
Console usage: ~pluck <+ / -> block <context>~
... ...
@@ -68,22 +70,22 @@ pluck + allow image/svg
68 70
In Pluckeye v1.0+, if you attempt to visit a blocked page, Pluckeye will redirect you to a page saying that the page is blocked and allowing you to view the rule that caused it to be blocked.
69 71
70 72
*** Examples
71
-#+BEGIN_EXAMPLE
72
-pluck + block youtube.com
73
-#+END_EXAMPLE
73
+ #+BEGIN_SRC sh
74
+ pluck + block youtube.com
75
+ #+END_SRC
74 76
75
-#+BEGIN_EXAMPLE
76
-pluck + block https://www.youtube.com/watch?v=8ftDjebw8aA
77
-#+END_EXAMPLE
77
+ #+BEGIN_SRC sh
78
+ pluck + block https://www.youtube.com/watch?v=8ftDjebw8aA
79
+ #+END_SRC
78 80
79
-#+BEGIN_EXAMPLE
80
-pluck + block image/png
81
-#+END_EXAMPLE
81
+ #+BEGIN_SRC sh
82
+ pluck + block image/png
83
+ #+END_SRC
82 84
83 85
To block video thumbnails on YouTube:
84
-#+BEGIN_EXAMPLE
85
-pluck + block i.ytimg.com
86
-#+END_EXAMPLE
86
+ #+BEGIN_SRC sh
87
+ pluck + block i.ytimg.com
88
+ #+END_SRC
87 89
88 90
** flee
89 91
/Main article: [[flee][Flee]]/
... ...
@@ -97,10 +99,10 @@ pluck + block i.ytimg.com
97 99
98 100
*** Examples
99 101
To block wikipedia.org, but keep the default behaviour (load with no images if you have the default configuration) for sg.wikipedia.org:
100
-#+BEGIN_EXAMPLE
101
-pluck + block wikipedia.org
102
-pluck + noop sg.wikipedia.org
103
-#+END_EXAMPLE
102
+ #+BEGIN_SRC sh
103
+ pluck + block wikipedia.org
104
+ pluck + noop sg.wikipedia.org
105
+ #+END_SRC
104 106
105 107
** when
106 108
Console usage: ~pluck <+ / -> when <schedule> <other rule type> <context>~
... ...
@@ -111,19 +113,19 @@ pluck + noop sg.wikipedia.org
111 113
112 114
*** Examples
113 115
To block /all/ internet access on Mondays, Wednesdays, and Fridays (~MWF~) from midnight to 8 am (~0-8~):
114
-#+BEGIN_EXAMPLE
115
-pluck + when MWF0-8 block everything
116
-#+END_EXAMPLE
116
+ #+BEGIN_SRC sh
117
+ pluck + when MWF0-8 block everything
118
+ #+END_SRC
117 119
118 120
To allow Facebook every day from noon to 1 pm (~12-13~) and also from 7 pm to 9 pm (~19-21~).
119
-#+BEGIN_EXAMPLE
120
-pluck + when 12-13&19-21 allow facebook.com
121
-#+END_EXAMPLE
121
+ #+BEGIN_SRC sh
122
+ pluck + when 12-13&19-21 allow facebook.com
123
+ #+END_SRC
122 124
123 125
You can also specify a time relative to the present. To block YouTube for the next half an hour:
124
-#+BEGIN_EXAMPLE
125
-when now+30m block youtube.com
126
-#+END_EXAMPLE
126
+ #+BEGIN_SRC sh
127
+ pluck + when now+30m block youtube.com
128
+ #+END_SRC
127 129
128 130
** Legacy
129 131
These rule types are oudated, but were used in older versions of Pluckeye.
... ...
@@ -155,9 +157,9 @@ These rule types are oudated, but were used in older versions of Pluckeye.
155 157
156 158
*** Examples
157 159
This will give you full internet access (as long as you don't already have ~block everything~ in your configuration):
158
-#+BEGIN_EXAMPLE
159
-pluck + allow everything
160
-#+END_EXAMPLE
160
+ #+BEGIN_SRC sh
161
+ pluck + allow everything
162
+ #+END_SRC
161 163
162 164
See [[#when][when]] above for an example of blocking everything only at certain times.
163 165
... ...
@@ -165,27 +167,27 @@ pluck + allow everything
165 167
Console usage: ~pluck <+ / -> <rule type> <host>~
166 168
167 169
*** Examples
168
-#+BEGIN_EXAMPLE
169
-pluck + allow google.com
170
-#+END_EXAMPLE
170
+ #+BEGIN_SRC sh
171
+ pluck + allow google.com
172
+ #+END_SRC
171 173
172 174
** IP addresses
173 175
Console usage: ~pluck <+ / -> <rule type> <IP address>~
174 176
175 177
*** Examples
176 178
**** IP v4
177
-#+BEGIN_EXAMPLE
178
-pluck + block 192.168.0.1
179
-#+END_EXAMPLE
179
+ #+BEGIN_SRC sh
180
+ pluck + block 192.168.0.1
181
+ #+END_SRC
180 182
181 183
**** IP v6
182
-#+BEGIN_EXAMPLE
183
-pluck + allow ::1
184
-#+END_EXAMPLE
184
+ #+BEGIN_SRC sh
185
+ pluck + allow ::1
186
+ #+END_SRC
185 187
186
-#+BEGIN_EXAMPLE
187
-pluck + block [::1234]
188
-#+END_EXAMPLE
188
+ #+BEGIN_SRC sh
189
+ pluck + block [::1234]
190
+ #+END_SRC
189 191
190 192
** Media types
191 193
/Main article: [[media-types][Media types]]/
... ...
@@ -197,9 +199,9 @@ pluck + block [::1234]
197 199
198 200
*** Examples
199 201
To block everything that is not specifically allowed until 3 pm (~15~) every day:
200
-#+BEGIN_EXAMPLE
201
-when 0-15 block otherwise
202
-#+END_EXAMPLE
202
+ #+BEGIN_SRC sh
203
+ pluck + when 0-15 block otherwise
204
+ #+END_SRC
203 205
204 206
** Ports
205 207
Console usage: ~pluck <+ / -> <rule type> [ip address] port <port number>~
... ...
@@ -207,38 +209,38 @@ when 0-15 block otherwise
207 209
Allow everything for a particular TCP / UDP port.
208 210
209 211
*** Examples
210
-#+BEGIN_EXAMPLE
211
-pluck + allow port 25
212
-#+END_EXAMPLE
212
+ #+BEGIN_SRC sh
213
+ pluck + allow port 25
214
+ #+END_SRC
213 215
214
-#+BEGIN_EXAMPLE
215
-pluck + allow 192.168.1.42 port 17
216
-#+END_EXAMPLE
216
+ #+BEGIN_SRC sh
217
+ pluck + allow 192.168.1.42 port 17
218
+ #+END_SRC
217 219
218 220
** Programs
219 221
Console usage: ~pluck <+ / -> <rule type> program <program name / executable>~
220 222
221 223
*** Examples
222
-#+BEGIN_EXAMPLE
223
-pluck + allow program /usr/bin/git
224
-#+END_EXAMPLE
224
+ #+BEGIN_SRC sh
225
+ pluck + allow program /usr/bin/git
226
+ #+END_SRC
225 227
226 228
** Subnets
227 229
Console usage: ~pluck <+ / -> <rule type> <subnet mask>~
228 230
229 231
*** Examples
230 232
To allow 192.168.x.x:
231
-#+BEGIN_EXAMPLE
232
-pluck + allow 192.168.0.0
233
-#+END_EXAMPLE
233
+ #+BEGIN_SRC sh
234
+ pluck + allow 192.168.0.0
235
+ #+END_SRC
234 236
235 237
** URLs
236 238
Console usage: ~pluck <+ / -> <rule type> <URL>~
237 239
238 240
*** Examples
239
-#+BEGIN_EXAMPLE
240
-pluck + allow https://en.wikipedia.org/wiki/Main_Page
241
-#+END_EXAMPLE
241
+ #+BEGIN_SRC sh
242
+ pluck + allow https://en.wikipedia.org/wiki/Main_Page
243
+ #+END_SRC
242 244
243 245
* Explicit form
244 246