.redirects.gollum
... ...
@@ -0,0 +1,4 @@
1
+---
2
+users-site/supporter-guide.md.md: users-site/supporter-guide.md
3
+users-site/imports.md: users-site/importing-configurations.md
4
+Troubleshooting.org: troubleshooting.org
Home.org
... ...
@@ -6,7 +6,7 @@ title: Pluckeye User Manual, a work in progress
6 6
7 7
* Using Pluckeye
8 8
9
-- [[https://www.pluckeye.net/quickstart.html][Quickstart]] (start here!)
9
+- [[quickstart][Quickstart]] (start here!)
10 10
- [[how-to-install][How to install Pluckeye]]
11 11
- [[command-line-basics.org][Using the command line]]
12 12
- [[Tips]]
... ...
@@ -15,6 +15,20 @@ title: Pluckeye User Manual, a work in progress
15 15
- [[how-to-update][How to update Pluckeye]]
16 16
- [[Troubleshooting]]
17 17
18
+* Users site
19
+
20
+ The [[https://u.pluckeye.net][Pluckeye users site]] allows users to expedite changes to each others' configurations, synchronize their configurations across devices, and share their configurations with each other.
21
+
22
+- [[users-site/glossary][Glossary]]
23
+- [[users-site/synchronizing-configurations][Synchronizing configurations]]
24
+- [[users-site/getting-supporters][Getting supporters]]
25
+- [[users-site/supporter-guide][Supporter guide]]
26
+- [[users-site/importing-configurations][Importing configurations]]
27
+- [[users-site/restricted-devices][Restricted devices]]
28
+- [[users-site/faq][FAQ]]
29
+- [[users-site/writing-a-description][Writing a description]]
30
+- [[users-site/features][Features]]
31
+
18 32
* Paper manual (from 2018)
19 33
20 34
A work in progress from 2018. Parts of it are out of date.
cohorts.org
... ...
@@ -1,22 +1,21 @@
1
+---
2
+title: Cohorts | Pluckeye
3
+---
4
+
1 5
[[_TOC_]]
2 6
3 7
* Overview
4 8
5
- If you want to use a long delay, you probably want to be involved in
6
- at least one Pluckeye cohort so that you can have changes to your
7
- configuration expedited by others from time to time.
9
+ If you want to use a long delay, you probably want to be involved in at least one Pluckeye cohort so that you can have changes to your configuration [[expedite][expedited]] by others from time to time.
8 10
9 11
A cohort is a group of users who can approve expedite requests for one
10 12
another.
11 13
12 14
* Joining
13 15
14
- Because cohorts are so valuable, users who register on
15
- [[https://u.pluckeye.net/]] are automatically assigned to a cohort.
16
- Users who don't want to be part of one may leave.
16
+ Because cohorts are so valuable, users who register on [[https://u.pluckeye.net/][the users site]] are automatically assigned to a cohort. Users who don't want to be part of one may leave.
17 17
18
- You may join any of the [[https://u.pluckeye.net/groups/public][public groups]] that are accepting new
19
- members.
18
+ You may join any of the [[https://u.pluckeye.net/groups/public][public groups]] that are accepting new members.
20 19
21 20
To be involved in a cohort, you must first agree to honor the ethos
22 21
of the cohort. That generally means respecting the group and those
... ...
@@ -31,25 +30,19 @@
31 30
32 31
* Approving expedite requests
33 32
34
- Expedite requests show up and can be approved at
35
- [[https://u.pluckeye.net/queue]] . The web page uses "notifications" so
36
- that by loading it into one of your browser tabs, you can be
37
- notified of an expedite request without needing to actively check
38
- the page.
33
+ Expedite requests from others show up and can be approved on [[https://u.pluckeye.net/queue][your queue]]. The web page uses "notifications" so that by loading it into one of your browser tabs, you can be notified of an expedite request without needing to actively check the page.
39 34
40 35
* Making an expedite request
41 36
42
- Making an expedite request is easy. Simply, allow a site using
43
- Pluckeye's =allow= button, then click the =expedite= button, and
44
- complete the resulting form. The awkward part as of this writing
45
- (2020-07-17) is that you have also have to to manually type =pluck
46
- mayprove= after somebody else approves your request. The timely
47
- invoking of =pluck mayprove= may one day be automatic.
37
+ Making an expedite request is easy.
38
+
39
+** v0.99 and older
40
+ Simply, allow a site using Pluckeye's =allow= button, then click the =expedite= button, and complete the resulting form. The awkward part as of this writing (2021-01-27) is that you also have to manually run =pluck mayprove= in a [[how-to-open-a-console-window][console window]] after somebody else approves your request. The timely invoking of =pluck mayprove= may one day be automatic.
48 41
49 42
* Avoiding expedite
50 43
51 44
If you have abused the expedite system, even once, you should
52
- probably use the noapproval option to prevent yourself from doing
45
+ probably use the [[features#noapproval][noapproval]] feature to prevent yourself from doing
53 46
that again.
54 47
55 48
#+BEGIN_SRC sh
commands.org
... ...
@@ -0,0 +1,356 @@
1
+---
2
+title: Commands | Pluckeye
3
+---
4
+ Pluckeye commands are typed in a [[how-to-open-a-console-window][console window]] and can be used to control Pluckeye. They are different than Pluckeye [[rules]].
5
+
6
+ If you are new to Pluckeye or you are looking just for the most commonly used commands, see [[command-line-basics][Command line basics]].
7
+
8
+ If you are unfamiliar with running commands in a console you should not need to do so often, as most actions can also be performed by clicking buttons in the Pluckeye browser extension. (If you have the browser extension installed, click on the Pluckeye button in the top right of your browser to get started.) If you do want to use commands, see [[notation][Notation]] for exactly how to type them in.
9
+
10
+ /To search this page by keyword, use/ *Ctrl + F* /on Windows & Linux or/ *Command + F* /on Mac./
11
+
12
+[[_TOC_|levels = 1]]
13
+
14
+* + (add)
15
+ Usage: ~pluck + [rule]~
16
+
17
+ Adds a rule to your configuration or enables a feature.
18
+
19
+** Examples
20
+ To add an [[rules#allow][allow]] rule:
21
+#+BEGIN_EXAMPLE
22
+pluck + allow wikipedia.org
23
+#+END_EXAMPLE
24
+
25
+#+BEGIN_EXAMPLE
26
+pluck + block image/
27
+#+END_EXAMPLE
28
+
29
+ To enable the [[system]] feature:
30
+#+BEGIN_EXAMPLE
31
+pluck + system
32
+#+END_EXAMPLE
33
+
34
+* - (minus)
35
+ Usage: ~pluck - [rule]~
36
+
37
+ Removes a rule from your configuration or disables a feature. For example, if you delete a ~block~ rule for a given site, Pluckeye reverts to the default setting of blocking images and video while allowing pages to otherwise load. (An exception to this rule occurs if you have changed the default `block image/`, `block video/`, or if you have conflicting rules already in place. For example, if you have ~allow google.com~ and ~block google.com~, the block rule overrides the allow rule. If the block rule is deleted, the allow rule succeeds. If the allow rule is also deleted, the default rule succeeds and blocks images and video while allowing the site to otherwise load.)
38
+
39
+ If you attempt to remove a rule that is not in your configuration, this command does nothing.
40
+
41
+** Examples
42
+ To remove an [[rules#allow][allow]] rule:
43
+#+BEGIN_EXAMPLE
44
+pluck - allow facebook.com
45
+#+END_EXAMPLE
46
+
47
+ To remove a [[rules#when]] rule:
48
+#+BEGIN_EXAMPLE
49
+pluck - when 8-9 allow youtube.com
50
+#+END_EXAMPLE
51
+
52
+ To disable the [[features#nhb][nhb]] feature:
53
+#+BEGIN_EXAMPLE
54
+pluck - nhb
55
+#+END_EXAMPLE
56
+
57
+* abort
58
+ Usage: ~pluck abort [context]~
59
+
60
+ Aborts pending rule changes (those that will take effect once the delay has elapsed). By default all pending rule changes are removed. If a website, page, program, etc. is given, all pending changes that match that context are removed.
61
+
62
+** Examples
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
+
65
+#+BEGIN_EXAMPLE
66
+pluck + allow wikipedia.org
67
+pluck abort
68
+#+END_EXAMPLE
69
+
70
+#+BEGIN_EXAMPLE
71
+pluck + allow https://example.com/foo
72
+pluck abort example.com
73
+#+END_EXAMPLE
74
+
75
+#+BEGIN_EXAMPLE
76
+pluck + allow example.com image/
77
+pluck abort image
78
+#+END_EXAMPLE
79
+
80
+* approved?
81
+ Usage: ~pluck approved?~
82
+
83
+ Fetches [[users-site/glossary#expedite][expedite]] approvals from [[//u.pluckeye.net/][the users site]]. Currently it is necessary to run this after one of your supporters has approved one of your expedite requests, in order for the change to take effect on your device. Hopefully this will be automatic in the future.
84
+
85
+* clear
86
+ Usage: ~pluck clear~
87
+
88
+ Removes /all/ Pluckeye rules, meaning you will have full Internet access after your [[delay]] elapses. It makes sense to run this once after you first install Pluckeye if you want Pluckeye to only block a few websites, and allow all access otherwise. There is no way to automatically go back to the configuration you had after running this. If you want to save your existing configuration so you can restore it later, you can use [[#export][export]] to do this.
89
+
90
+ /See also: [[rules#everything][allow everything]]/
91
+
92
+* compact
93
+ Usage: ~pluck compact~
94
+
95
+ A maintenance command to shrink data.
96
+
97
+* delay
98
+ /Main article: [[delay]]/
99
+
100
+* delays
101
+ Usage: ~pluck delays~
102
+
103
+ Prints the current delay, and also [[delay#delay-patterns-advanced-pluckeye-1-0][non-standard delays]] that apply to specific websites, pages, programs, etc.
104
+
105
+* eval
106
+ Usage: ~pluck eval [-x] <context>~
107
+
108
+ Evaluates whether a given website, page, program, etc. is allowed according to your current configuration. It can be used to troubleshoot why something is or isn't being displayed. Note that merely giving a website will tell you whether the website will load, not whether images or video on the website are allowed. (See the examples.)
109
+
110
+ By default, the command has an exit code of 0 unless an error occurs. If the ~-x~ flag is used, the command will have an exit code of 0 if the result was ~allow~ or ~null~, and a non-zero exit code if it was ~block~. (If you have no idea what this means, then you have no use for the ~-x~ flag.) This is mainly useful in scripts.
111
+
112
+** Examples
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
+
115
+ Input (what you type):
116
+#+BEGIN_EXAMPLE
117
+pluck eval google.com
118
+#+END_EXAMPLE
119
+
120
+ Output (what the computer adds):
121
+#+BEGIN_EXAMPLE
122
+allow because of rule 330: allow
123
+#+END_EXAMPLE
124
+
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
+
127
+ Input:
128
+#+BEGIN_EXAMPLE
129
+pluck eval google.com image/
130
+#+END_EXAMPLE
131
+
132
+ Output:
133
+#+BEGIN_EXAMPLE
134
+block because of rule 420: block image/
135
+#+END_EXAMPLE
136
+
137
+* export
138
+ Usage: ~pluck export~
139
+
140
+ Prints your Pluckeye configuration and any pending changes to it. (In technical terms, it prints all of the rules in your Pluckeye configuration and all pending rule changes to standard output.) You can also use it (as shown in the examples) to save your configuration in a file.
141
+
142
+** Examples
143
+ All of these examples demonstrate how to create a file on your Desktop that contains your Pluckeye configuration.
144
+
145
+*** Windows
146
+#+BEGIN_EXAMPLE
147
+cd Desktop
148
+pluck export > pluckeye-configuration.txt
149
+#+END_EXAMPLE
150
+
151
+*** Linux or Mac OS
152
+#+BEGIN_EXAMPLE
153
+cd ~/Desktop
154
+pluck export > pluckeye-configuration.txt
155
+#+END_EXAMPLE
156
+
157
+* factoryreset
158
+ Usage: ~pluck factoryreset~
159
+
160
+ Resets Pluckeye to its "factory" settings (i.e., as if you had just installed for the first time). Your current configuration /will be lost/. If you plan to reuse or restore your current configuration, make sure you [[#export][export]] and save it to a configuration file before performing the factory reset.
161
+
162
+* features
163
+ Usage: ~pluck features~
164
+
165
+ Prints enabled features, such as [[#system][system]] and [[#nhb][nhb]].
166
+
167
+* find
168
+ Usage: ~pluck find <term(s)>~
169
+
170
+ /This feature was added to Pluckeye in versoin 1.0, so if you are using an older version of Pluckeye, this will not work for you./
171
+
172
+ Print rules in your configuration that match the given term(s). (In more technical terms, if any of the terms is a substring of a given rule, that rule is printed.)
173
+
174
+** Examples
175
+ The output of this command will depend on your Pluckeye configuration; the default configuration produced the outputs shown here.
176
+
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
181
+
182
+ Input:
183
+#+BEGIN_EXAMPLE
184
+pluck find image/
185
+#+END_EXAMPLE
186
+
187
+ Output:
188
+#+BEGIN_EXAMPLE
189
+allow image/svg+xml
190
+block image/
191
+#+END_EXAMPLE
192
+
193
+* future
194
+ Usage: ~pluck future~
195
+
196
+ Prints all pending changes to your configuration.
197
+
198
+* import
199
+ Usage: ~pluck import [configuration file]~
200
+
201
+ Overrides current configuration and imports a configuration file. The configuration file should contain a list of Pluckeye rules, with one rule per line. Lines starting with ~#~ will be ignored, so it can be used to add comments.
202
+
203
+** Examples
204
+ Before running this command, first open the terminal in the directory (AKA folder) containing the pluckeye-configuration.txt file that you want to import.
205
+
206
+#+BEGIN_EXAMPLE
207
+pluck import pluckeye-configuration.txt
208
+#+END_EXAMPLE
209
+
210
+* import-allow
211
+ Usage: ~pluck import-allow [context file]~
212
+
213
+ 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.
214
+
215
+** Examples
216
+#+BEGIN_EXAMPLE
217
+pluck import-allow good-websites.txt
218
+#+END_EXAMPLE
219
+
220
+In good-websites.txt, there could be:
221
+#+BEGIN_EXAMPLE
222
+google.com
223
+facebook.com
224
+https://youtube.com/watch
225
+#+END_EXAMPLE
226
+
227
+* import-block
228
+ Usage: ~pluck import-block [context file]~
229
+
230
+ Similar to [[#import-allow][import-allow]], but all of the websites, pages, programs, etc. in the context file will be blocked.
231
+
232
+** Examples
233
+#+BEGIN_EXAMPLE
234
+pluck import-block bad-websites.txt
235
+#+END_EXAMPLE
236
+
237
+* mayprove
238
+ Usage: ~pluck mayprove~
239
+
240
+ Synonym for [[#approved][approved?]].
241
+
242
+* mety
243
+ Usage: ~pluck mety .<extension>~
244
+
245
+ Prints the media type for the specified extension.
246
+
247
+** Examples
248
+#+BEGIN_EXAMPLE
249
+pluck mety .css
250
+#+END_EXAMPLE
251
+
252
+ In this case, the output would be:
253
+#+BEGIN_EXAMPLE
254
+.css -> text/css
255
+#+END_EXAMPLE
256
+ which tells you that the media type of CSS files is ~text/css~.
257
+
258
+* refresh
259
+ Usage: ~pluck refresh~
260
+
261
+ Refetches configurations from [[//u.pluckeye.net/][the users site]]. If you don't know what this means, check out [[users-site/synchronizing-configurations][Synchronizing configurations]].
262
+
263
+ /See also: [[#sync][sync]]/
264
+
265
+* repair
266
+ Usage: ~pluck repair~
267
+
268
+ Attempt to repair Internet access.
269
+
270
+* replace
271
+ Usage: ~pluck replace <string0> <string1>~
272
+
273
+ This more technically advanced command reads standard input, replaces all instances of string0 with string 1, and prints the result on standard output. This is useful when pipelining.
274
+
275
+** Examples
276
+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.
277
+#+BEGIN_EXAMPLE
278
+pluck find example.com | pluck replace allow "when now+5m block" | pluck import -
279
+#+END_EXAMPLE
280
+
281
+* supplicate
282
+ Usage: ~pluck supplicate~
283
+
284
+ Sends expedite requests to [[//u.pluckeye.net/][the users site]] so that someone else can approve them.
285
+
286
+* sync
287
+ Usage: ~pluck sync~
288
+
289
+ Synchronizes your device's configuration with the one assigned to it on [[//u.pluckeye.net/][the users site]]. If you don't know what this means, check out [[users-site/synchronizing-configurations][Synchronizing configurations]].
290
+
291
+ /See also: [[#refresh][refresh]]/
292
+
293
+* trim
294
+ Usage: ~pluck trim~
295
+
296
+ A maintenance command to shrink data.
297
+
298
+* unimport
299
+ Usage: ~pluck unimport [configuration file]~
300
+
301
+ Similar to import, except that it removes all of the rules in the configuration file instead of adding them.
302
+
303
+* unimport-allow
304
+ Usage: ~pluck unimport-allow [context file]~
305
+
306
+ Similar to [[#import-allow][import-allow]], except that it removes ~allow~ rules for each of the websites, pages, programs, etc. in the context file instead of adding them.
307
+
308
+* unimport-block
309
+ Usage: ~pluck unimport-block [context file]~
310
+
311
+ Similar to [[#import-block][import-block]], except that it removes ~block~ rules for each of the websites, pages, programs, etc. in the context file instead of adding them.
312
+
313
+* uninstall
314
+ Usage: ~pluck uninstall~
315
+
316
+ Uninstalls Pluckeye. The delay must be 0 before you do this.
317
+
318
+* upload
319
+ Usage: ~pluck upload~
320
+
321
+ Upload your local configurations to [[//u.pluckeye.net/][the users site]]. See [[users-site/synchronizing-configurations][Synchronizing configurations]] for more info.
322
+
323
+* verdicts
324
+ Usage: ~pluck verdicts~
325
+
326
+ Print recent Internet connection attempts and whether Pluckeye allowed or blocked them.
327
+
328
+* version
329
+ Usage: ~pluck version~
330
+
331
+ Print the version of Pluckeye that is installed.
332
+
333
+* Legacy
334
+ These commands are outdated, but were used in older versions of Pluckeye.
335
+
336
+** add
337
+ Replaced by [[#add][+ (add)]], which works the same way.
338
+
339
+** del
340
+ Replaced by [[#minus][- (minus)]], which works the same way.
341
+
342
+** level
343
+ Usage: ~pluck level [new level]~
344
+
345
+ Sets the level. Replaced by the [[system][system feature]].
346
+
347
+** rm
348
+ Replaced by [[#minus][- (minus)]], which works the same way.
349
+
350
+** set
351
+ Usage: ~pluck set "delay <new delay>"~
352
+
353
+ Sets the delay. Replaced by [[#delay][delay]].
354
+
355
+** unbork
356
+ Replaced by [[#repair][repair]].
delay.org
... ...
@@ -16,7 +16,7 @@ have immediate effect.
16 16
#+END_SRC
17 17
18 18
However, when the delay is not 0 (nil), *any changes to settings that
19
-will result /in greater access/ will be delayed*.
19
+will result in greater access will be delayed*.
20 20
21 21
For example, even after the following sequence of commands is ran,
22 22
full access to b.com will still not be granted until 3 seconds have
... ...
@@ -46,7 +46,7 @@ E.g.,
46 46
#+END_SRC
47 47
48 48
In addition, changing the installation level or uninstalling requires
49
-that the delay be 0. So, the following will not result in pluckeye
49
+that the delay be 0. So, the following will not result in Pluckeye
50 50
being uninstalled.
51 51
52 52
#+BEGIN_SRC sh
... ...
@@ -54,7 +54,7 @@ being uninstalled.
54 54
pluck uninstall
55 55
#+END_SRC
56 56
57
-But the next sequence of commands will.
57
+But this sequence of commands will (assuming the delay is 3 seconds):
58 58
59 59
#+BEGIN_SRC sh
60 60
pluck delay 0
... ...
@@ -64,7 +64,7 @@ But the next sequence of commands will.
64 64
65 65
See [[tips]] for some other tips on the delay and related features.
66 66
67
-* varying the delay by time of day
67
+* Varying the delay by time of day
68 68
69 69
Pluckeye allows you to vary the delay by time of day.
70 70
... ...
@@ -74,7 +74,7 @@ See [[tips]] for some other tips on the delay and related features.
74 74
pluck when 12-24 delay 7200
75 75
#+END_SRC
76 76
77
-* delay patterns (advanced, Pluckeye 1.0+)
77
+* Delay patterns (advanced, Pluckeye 1.0+)
78 78
79 79
Delay patterns are somewhat complex, hard to describe, and to use
80 80
them well may require some significant thought. If those hurdles
... ...
@@ -125,3 +125,6 @@ See [[tips]] for some other tips on the delay and related features.
125 125
pluck delay 10h "- block" # delay removing any block by 10 hours
126 126
pluck delay 24h "+ allow everything" # delay whiteout by 24 hours
127 127
#+END_SRC
128
+
129
+* Importing configurations
130
+ On [[//u.pluckeye.net/][the users site]], devices have delays as well as configurations. A delay on a device governs only the delay for changing the configuration assigned to that device; it does not govern changes to the configuration itself.
editing-the-manual.org
... ...
@@ -46,6 +46,18 @@ title: editing the manual
46 46
47 47
Also, take a look at the useful links below.
48 48
49
+* OS-specific sections
50
+ Some pages (e.g., [[how-to-install][How to install]]) have sections relating to specific operating systems. Since usually only one of these sections is relevant to the reader, JavaScript has been added that can automatically hide irrelevent sections on such pages, and give the reader a button to toggle the visibility of these sections. The possible OSes are:
51
+
52
+- Android
53
+- Chrome OS
54
+- iOS
55
+- Linux
56
+- Mac OS X
57
+- Windows
58
+- Windows Phone
59
+- Unknown
60
+
49 61
* Useful links
50 62
51 63
** Syntax, layout, and features in this wiki
family.org
... ...
@@ -80,7 +80,7 @@ computer by way of example.
80 80
** Synchronizing configuration for monitoring
81 81
82 82
If Peter is a careful person, he'll create an account on
83
- [[https://u.pluckeye.net/]] , and then he'll start [[https://u.pluckeye.net/doc/synchronize-configurations][configuration
83
+ [[https://u.pluckeye.net/]] , and then he'll start [[synchronizing-configurations][configuration
84 84
synchronization]] like so:
85 85
86 86
#+BEGIN_SRC sh
faq.org
... ...
@@ -1,7 +1,10 @@
1
-If you're not already a Pluckeye user, you may want to take a look at
2
-[[https://www.pluckeye.net/faq-about.html][non-user FAQ]] instead of this page.
1
+---
2
+title: FAQ
3
+---
3 4
4
-[[_TOC_]]
5
+If you're not already a Pluckeye user, you may want to take a look at the [[https://www.pluckeye.net/faq-about.html][non-user FAQ]] instead of this page.
6
+
7
+[[_TOC_|levels = 2]]
5 8
6 9
* Using Pluckeye FAQ
7 10
... ...
@@ -11,172 +14,126 @@ If you're not already a Pluckeye user, you may want to take a look at
11 14
12 15
See [[platforms]] for more information.
13 16
14
-** How do I install pluckeye?
17
+** How do I install / uninstall Pluckeye?
15 18
16 19
See [[how-to-install]].
17 20
18
-** How do I uninstall Pluckeye?
19
-
20
- See the uninstallation instructions on [[how-to-install.org]].
21
-
22 21
** What are the recommended practices for using Pluckeye?
23 22
24
- See the [[tips.org][tips]] page.
25
-
26
-** What does "level 1" mean?
27
-
28
- See the [[levels.org][installation levels]] page.
23
+ See the [[tips]] page.
29 24
30 25
** What browsers does Pluckeye work with?
31 26
32 27
Pluckeye is built to work with Chrome, but is also mostly compatible
33
- with [[https://brave.com/][Brave]], [[https://www.mozilla.org/en-US/firefox/new/][Firefox]], [[http://www.palemoon.org][Pale Moon]] (a classic Firefox), [[https://vivaldi.com][Vivaldi]], and other
34
- Firefox and Chrome variants.
28
+ with [[https://brave.com/][Brave]], [[https://www.mozilla.org/en-US/firefox/new/][Firefox]], [[http://www.palemoon.org][Pale Moon]] (a classic Firefox), [[https://vivaldi.com][Vivaldi]], and other Firefox and Chrome variants.
35 29
36
- When the =system= feature is enabled (aka level 2), Pluckeye will
37
- block all browsers with which it does not integrate such as Internet
38
- Explorer, Safari, and others.
30
+ When the [[system][system feature]] is enabled (which used to be known as level 2), Pluckeye will block all browsers with which it does not integrate, such as Internet Explorer and Safari.
39 31
40
-** Where do I type the pluck commands that are mentioned on this site?
32
+** Where do I type the ~pluck~ commands that are mentioned on this site?
41 33
42
- Command such as
34
+ [[commands][Commands]] such as
43 35
44 36
#+BEGIN_SRC sh
45 37
pluck + allow example.com
46 38
#+END_SRC
47 39
48
- are typed in [[how-to-open-a-console-window.org][a console window]], aka a terminal on Mac OS X or Linux.
49
- You'll need to learn to open and type in one if you want to use
50
- some advanced features such as scheduled rules.
40
+ are typed in [[how-to-open-a-console-window.org][a console window]] (AKA a terminal on Mac OS X or Linux). You'll need to learn to open and type in one if you want to use some advanced features such as [[rules#when][scheduled rules]]. However, the basic feature set requires only pointing and clicking in the browser, and many people use Pluckeye without typing anything, ever.
51 41
52
- However, the basic feature set requires only pointing and clicking
53
- in the browser, and many people use Pluckeye without typing
54
- anything, ever.
42
+ For a longer explanation of how to type in commands, see [[notation]].
55 43
56
- For a longer explanation of code blocks, see [[notation]].
44
+** What is a ___?
45
+See the [[glossary]].
57 46
58 47
** How do I whitelist a site?
48
+ Keep in mind that no matter how you do this, the new setting will only be effective after the Pluckeye [[delay]] waiting period.
59 49
60
- In Chrome, click on the Pluckeye button, and then click =allow=.
61
-
62
- Or, from the command line:
50
+*** Through the browser extension
51
+**** v1.0
52
+ In Chrome, click on the Pluckeye button (usually in the top right), and then click the "allow <website>" button immediately below "New Rule".
63 53
64
- #+BEGIN_SRC sh
65
- pluck + allow mysite.org
66
- #+END_SRC
54
+**** v0.99 and older
55
+ In Chrome, click on the Pluckeye button (usually in the top right), and then click =allow=.
67 56
68
- Keep in mind that the new setting is effective only after the
69
- pluckeye delay waiting period.
57
+*** Through a console
58
+ Use the [[rules#everything][allow everything rule]].
70 59
71 60
** How do I block only "bad sites"?
72 61
73 62
See [[how-to-block-only-bad-sites][this guide]].
74 63
64
+** How do I schedule allowing or blocking of a website?
65
+
66
+ Use a [[rules#when][when rule]].
67
+
75 68
** How do I completely cut off Internet access at night?
76 69
77
- To schedule daily blackouts from midnight to 6am and from 9pm (21:00) to midnight:
70
+ To schedule daily blackouts from midnight to 6am (~0-6~) and from 9pm to midnight (~21-24~):
78 71
79 72
#+BEGIN_SRC sh
80 73
pluck + when 0-6&21-24 block everything
81 74
#+END_SRC
82
-
83
-** How do I schedule allowing or blocking of a website?
84
-
85
- See [[how-to-filter-by-time]].
75
+
76
+ Use a [[rules#when][when rule]] and the [[rules#everything][everything context]] to understand how this works.
86 77
87 78
** How do I block or allow part of a website, but not all of it?
88 79
89
- Yes. Pluckeye supports blocking by URL. There are 2 ways to do
90
- it.
91
-
92
- 1. Chrome > Pluckeye button > Allow > Click the "down arrow" (aka caret) to allow a specific url.
93
-
94
- 2. Use a terminal and add a rule for the url you would like to allow.
95
-
96
- #+BEGIN_SRC sh
97
- pluck + allow https://flickr.com/photos/myfamily
98
- #+END_SRC
80
+ See [[rules#how-to-add-a-rule][How to add a rule]].
99 81
100 82
** How do I transfer (export/import) my Pluckeye settings between computers?
101 83
102 84
There are two ways.
103 85
104
- The easy way is to login to https://u.pluckeye.net/ from both
105
- devices, and to upload the configuration from the first device as
106
- described on [[https://u.pluckeye.net/doc/synchronize-configurations][synchronize configurations]]. I.e.,
86
+ The easy way is to login to [[//u.pluckeye.net/][the users site]] from both devices, and to upload the configuration from the first device as described on [[synchronizing-configurations][synchronizing-configurations]]. I.e.,
107 87
108 88
#+BEGIN_SRC sh
109 89
pluck upload
110 90
#+END_SRC
111 91
112
- The harder way, for those who don't want to use u.pluckeye.net, is
113
- to use the export and import commands. It's harder because you
114
- have to copy the files yourself, and unlike [[https://u.pluckeye.net/doc/synchronize-configurations][synchronized
115
- configurations]], will not result in future changes being
116
- synchronized between the devices. To do it, first, export the
117
- settings from the source computer:
118
-
119
- On Mac OS X or Linux:
92
+ The harder way, for those who don't want to use the users site, is to use the [[commands#export][export]] and [[commands#import][import]] commands. It's harder because you have to copy the files yourself, and unlike [[synchronizing-configurations][synchronized configurations]], will not result in future changes being synchronized between the devices. To do it this way:
93
+ 1. Export the configuration from the source computer as shown in the examples for the [[commands#export][export command]].
94
+ 2. Copy pluckeye-configuration.txt from the desktop of the source computer to the desktop on the destination computer.
95
+ 3. On the destination computer, import the configuration using the [[commands#import][import command]].
120 96
121
- #+BEGIN_SRC sh
122
- cd ~/Desktop && pluck export >pluckeye-settings.txt
123
- #+END_SRC
124
-
125
- On Windows
126
-
127
- #+BEGIN_SRC bat
128
- pluck export > "%HOMEPATH%\Desktop\pluckeye-settings.txt"
129
- #+END_SRC
130
-
131
- Then, copy pluckeye-settings.txt from the desktop of the source
132
- computer to the desktop on the destination computer.
133
-
134
- Then, on the destination computer, import the settings:
135
-
136
- On Mac OS X or Linux:
97
+** How do I manually remove a rule?
137 98
138
- #+BEGIN_SRC sh
139
- pluck import pluckeye-settings.txt
140
- #+END_SRC
99
+*** Through the browser extension
100
+**** v0.99 and older
101
+ If the rule was added using the "allow" button in Chrome, the "revert" button will remove the rule.
141 102
142
- On Windows
103
+*** Through a console window
104
+ Use the [[commands#minus][- (minus) command]].
143 105
144
- #+BEGIN_SRC bat
145
- pluck import "%HOMEPATH%\Desktop\pluckeye-settings.txt"
146
- #+END_SRC
106
+** What is the complete syntax for rules and settings?
147 107
148
-** How do I manually remove a rule?
108
+ See [[rule-syntax.txt]].
149 109
150
- If the rule was added using the "allow" button in Chrome,
151
- the "Default" button will remove the rule.
110
+** Can I whitelist a URL, perhaps using wildcards, pattern matching, a specific resource or something similar?
152 111
153
- At the command line, you can use pluck -. For example,
112
+ Yes, and no. As of Pluckeye 1.0 literal urls and url prefixes are supported, using the [[commands#add][+ (add) command]]:
154 113
155
- #+BEGIN_SRC sh
156
- pluck + allow wikipedia.org
157
- pluck - allow wikipedia.org
158
- #+END_SRC
114
+ Full regular expressions support is not yet implemented, and may never be. If you would like regex support, see [[http://pluckeye.uservoice.com/forums/137031-general/suggestions/7936581-support-partial-urls-wildcards][this uservoice suggestion]].
159 115
160
-** What is the complete syntax for rules and settings?
116
+** Why can't I see the contents of blacklists on [[//u.pluckeye.net/][the users site]]?
117
+ The content of the blacklists are hidden by default because some people report that the textual content in blacklists can trigger behavior they are trying to change. If you want to see the content of the blacklists, you need to include the string 'wigwam' in your profile description and wait for your delay (if any) to elapse.
161 118
162
- See [[rule-syntax.txt]].
119
+** Why can't I publish (make public) my general configuration on [[//u.pluckeye.net/][the users site]]?
120
+ Currently only admins can publish general configurations. General configurations may contain powerful rules like [[rules#everything][block everything]], which overrides other rules. Since users can import public configurations into their own configurations, if anyone could publish general configurations, someone might import a very restrictive configuration into their own without realizing how restrictive it is. You can still publish other types of configurations, though.
163 121
164
-** Can I whitelist a URL, perhaps using wildcards, pattern matching, a specific resource or something similar?
122
+** Why can't I assign an import list to my device?
123
+ Currently only general configurations can be assigned to devices. This is because other configuration types are limited in the kinds of rules they can contain, and a user should never be prevented from adding a rule to their local configuration (though some rules are subject to their [[delay]]). For example, if you had an import list assigned to your device and you ran ~pluck + allow example.com~, it would be impossible to add the rule, since "allow" rules cannot appear in import lists. (In theory the rule could be added to one of the configurations listed in the import list, but there is no good way of determining which one of these it should be added to.)
165 124
166
- Yes, and no. As of Pluckeye 0.31.0, literal urls and url prefixes
167
- are supported, like so:
125
+** Why can't I import one of my general configurations into my import list?
126
+ Unpublished (i.e., private) general configurations cannot be imported into import lists. The reason for this is the same as the [[#why-can-t-i-publish-make-public-my-general-configuration][reason only admins can publish general configurations]. To get around this, you can use a general configuration (which can import any configuration type) instead of an import list.
168 127
169
- #+BEGIN_SRC sh
170
- pluck + allow https://flickr.com/photos/myfamily
171
- #+END_SRC
128
+** How do I use [[expedite]] on mobile?
129
+ Expedite only works with Pluckeye on desktop systems (Windows, Mac OS X, and Linux). It is hoped that it will one day work on mobile as well.
172 130
173
- Full regular expressions support is not yet implemented, and may
174
- never be. If you would like regex support, see [[http://pluckeye.uservoice.com/forums/137031-general/suggestions/7936581-support-partial-urls-wildcards][this uservoice
175
- suggestion]].
131
+** Does [[//u.pluckeye.net/][the users site]] collect data about users? What's your privacy policy?
132
+ See the user site's [[https://u.pluckeye.net/doc/privacy][privacy policy]], which is short and easy to read.
176 133
177 134
** Can Pluckeye notify my accountability partner?
178 135
179
- See the [[https://u.pluckeye.net/doc/get-supporters][documentation on Inspectors]].
136
+ See the [[getting-supporters][documentation on Inspectors]].
180 137
181 138
** I share a computer with others. Is it possible for some users to use Pluckeye while other users are completely oblivious to Pluckeye's presence?
182 139
... ...
@@ -189,40 +146,33 @@ If you're not already a Pluckeye user, you may want to take a look at
189 146
190 147
** How can I watch videos on youtube?
191 148
192
- It depends. One option is to schedule access to youtube. E.g., to
193
- only allow media from youtube on Mondays 10am - 12pm:
149
+ It depends. One option is to schedule access to YouTube using a [[rules#when][when rule]]. E.g., to only allow media from YouTube on Mondays 10am - 12pm:
194 150
195 151
#+BEGIN_SRC sh
196 152
pluck + when M10-12 allow youtube.com
197 153
#+END_SRC
198 154
199
- Another option is to allow one of the following "clean" youtube sites.
200
-
201
- - [[https://www.youtubekids.com/]]
202
- - [[http://cleanvideosearch.com/]]
203
- - [[http://safeyoutube.net/]]
155
+ Another option is to allow [[https://www.youtubekids.com/][YouTube Kids]]:
204 156
205 157
#+BEGIN_SRC sh
206
- pluck + allow cleanvideosearch.com
207
- pluck + allow safeyoutube.net
158
+ pluck + allow youtubekids.com
208 159
#+END_SRC
209 160
210
- Another option is to whitelist only specific videos.
161
+ Another option is allow only specific videos.
211 162
212
- Another option is to use a Chromium-based browser and enforce moderate
213
- mode:
163
+ Another option is to use a Chromium-based browser and enforce "moderate mode" (the [[safe][safesearch]] feature):
214 164
215 165
#+BEGIN_SRC sh
216 166
pluck + safesearch
217 167
#+END_SRC
218 168
219
- or restricted mode:
169
+ or "restricted mode" (the [[safe][safesearchstrict]] feature):
220 170
221 171
#+BEGIN_SRC sh
222 172
pluck + safesearchstrict
223 173
#+END_SRC
224 174
225
- Possibly with
175
+ Possibly with the [[features#nofirefox][nofirefox]] feature:
226 176
227 177
#+BEGIN_SRC sh
228 178
pluck + nofirefox
... ...
@@ -230,20 +180,19 @@ If you're not already a Pluckeye user, you may want to take a look at
230 180
231 181
** How can I enforce safe search?
232 182
233
- You can enforce safe search on google.com by using Chrome or a
234
- Chromium-based browser and the following options:
183
+ You can enforce safe search on google.com by using Chrome or a Chromium-based browser and enabling the [[safe][safesearch]] feature:
235 184
236 185
#+BEGIN_SRC sh
237 186
pluck + safesearch
238 187
#+END_SRC
239 188
240
- or
189
+ or the [[safe][safesearchstrict]] feature:
241 190
242 191
#+BEGIN_SRC sh
243 192
pluck + safesearchstrict
244 193
#+END_SRC
245 194
246
- possibly with
195
+ possibly with:
247 196
248 197
#+BEGIN_SRC sh
249 198
pluck + nofirefox
... ...
@@ -251,10 +200,11 @@ If you're not already a Pluckeye user, you may want to take a look at
251 200
pluck + block duckduckgo.com
252 201
#+END_SRC
253 202
254
-** How do I install linux?
203
+** How do I install Linux?
204
+
205
+ * [[https://help.ubuntu.com/community/Lubuntu/GetLubuntu/LTS]]
255 206
256
- [[https://help.ubuntu.com/community/Lubuntu/GetLubuntu/LTS]]
257
- [[http://www.ubuntu.com/download/desktop]]
207
+ * [[http://www.ubuntu.com/download/desktop]]
258 208
259 209
** How do I block torrents?
260 210
... ...
@@ -278,17 +228,16 @@ If you're not already a Pluckeye user, you may want to take a look at
278 228
pluck + block application/x-iso9660-image
279 229
#+END_SRC
280 230
281
-** How do I block or unblock pdfs or other documents?
231
+** How do I block or unblock PDFs or other documents?
282 232
283
- To allow pdfs or doc files or other documents on specific sites,
284
- one generally just allows a url, or a domain. E.g.,
233
+ To allow PDFs or .docx files or other documents on specific sites, one generally just allows a url, or a domain. E.g.,
285 234
286 235
#+BEGIN_SRC sh
287 236
pluck + allow http://my-college.edu/courses
288 237
pluck + allow my-church.or
289 238
#+END_SRC
290 239
291
- To block pdfs on most sites:
240
+ To block PDFs on most sites:
292 241
293 242
#+BEGIN_SRC sh
294 243
pluck + block application/pdf
... ...
@@ -332,12 +281,12 @@ If you're not already a Pluckeye user, you may want to take a look at
332 281
#+END_SRC
333 282
334 283
Note that you may need to configure Mail using [[https://static.pluckeye.net/images/screenshots/mac14-mail-account-provider-other.png][Other Mail Account]].
335
- For Gmail accounts, you will need to enable the [[https://myaccount.google.com/lesssecureapps][less secure apps
336
- option.]]
284
+ For Gmail accounts, you will need to enable the [[https://myaccount.google.com/lesssecureapps][less secure apps option.]]
337 285
338 286
Note that the above settings will not permit images in most HTML
339 287
email. Such images can't be allowed at present without also
340
- allowing *all of Safari*, a feature that almost no Plucker wants.
288
+ allowing *all of Safari*, a feature that almost no Pluckeye user
289
+ wants.
341 290
342 291
In Pluckeye before v0.99, at installation level 2, iTunes and the
343 292
App Store are blocked on some machines. The workaround is to
... ...
@@ -356,9 +305,7 @@ If you're not already a Pluckeye user, you may want to take a look at
356 305
357 306
** How do I block the Windows App Store?
358 307
359
- The Microsoft App Store is blocked by [[nhb.org][nhb]]. But if nhb is too
360
- severe for you, if if using Pluckeye v0.99.24+, the app store can
361
- be blocked with
308
+ The Microsoft App Store is blocked by the [[nhb][NHB]] feature. But if NHB is too severe for you and you are using Pluckeye v0.99.24+, the app store can be blocked with
362 309
363 310
#+BEGIN_SRC sh
364 311
pluck + block program winstore.app.exe
... ...
@@ -380,17 +327,18 @@ If you're not already a Pluckeye user, you may want to take a look at
380 327
pluck factoryreset
381 328
#+END_SRC
382 329
330
+ This will overwrite your existing configuration. If you want to save a copy of your configuration for later, use the [[commands#export][export command]].
331
+
383 332
** What if Pluckeye doesn't block enough for my tastes?
384 333
385
- You may want to enable the [[nhb.org][NHB option]].
334
+ You may want to enable the [[nhb][NHB]] feature.
386 335
387 336
** Does Pluckeye support password protection?
388 337
389
- Yes. Pluckeye calls this a "restricted device" setup, and it is
390
- intender /other control/ such as parental control rather than /self
391
- control/. See https://u.pluckeye.net/doc/restricted-device .
338
+ Yes. Pluckeye calls this a "[[restricted-devices][restricted device]]" setup, and it is intended for /other control/ (such as parental control) rather than /self
339
+ control/.
392 340
393
-** How can I use my network printer when Pluckeye is at level 2 and blocks by default?
341
+** How can I use my network printer with the [[system]] feature enabled?
394 342
395 343
#+BEGIN_SRC sh
396 344
pluck + allow port 3910
... ...
@@ -455,7 +403,7 @@ If you're not already a Pluckeye user, you may want to take a look at
455 403
pluck + allow pythonhosted.org
456 404
#+END_SRC
457 405
458
-** How do I use [[https://brew.sh/][Homebrew]] on Mac OS X at installation level 2?
406
+** How do I use [[https://brew.sh/][Homebrew]] on Mac OS X with the [[system]] feature enabled?
459 407
460 408
Run the following commands in a terminal.
461 409
... ...
@@ -482,13 +430,14 @@ If you're not already a Pluckeye user, you may want to take a look at
482 430
=HOMEBREW_NO_ENV_FILTERING=1= before =brew tap homebrew/core=, and
483 431
then to run =brew update=.
484 432
485
- Alternatively, you could use a periodic whiteout. E.g., to reserve
486
- time on Saturdays from 12pm to 2pm for homebrew updating:
433
+ Alternatively, you could use a periodic whiteout. E.g., to reserve time on Saturdays from 12pm to 2pm for homebrew updating:
487 434
488 435
#+BEGIN_SRC sh
489 436
pluck + when A12-14 allow everything
490 437
#+END_SRC
491 438
439
+ See [[rules#when][when]] and [[rules#everything][everything]] to understand how this works.
440
+
492 441
** How do I unblock a program such as Steam?
493 442
494 443
First, start the program. In this case, we'll use the program
... ...
@@ -535,7 +484,7 @@ If you're not already a Pluckeye user, you may want to take a look at
535 484
pluck + allow repository.playonlinux.com
536 485
#+END_SRC
537 486
538
-** How do I modify Pluckeye configuratino in an ordinary editor?
487
+** How do I modify Pluckeye configurations in an ordinary text editor?
539 488
540 489
If you only want to add settings:
541 490
... ...
@@ -553,6 +502,8 @@ If you're not already a Pluckeye user, you may want to take a look at
553 502
pluck clear
554 503
pluck import settings.txt
555 504
#+END_SRC
505
+
506
+ But using [[rules#through-the-users-site][the users site]] may be easier.
556 507
557 508
** How do I temporarily override a "block otherwise"?
558 509
... ...
@@ -560,14 +511,13 @@ If you're not already a Pluckeye user, you may want to take a look at
560 511
pluck + block otherwise
561 512
#+END_SRC
562 513
563
-** How do I allow or require another person to approve changes to Pluckeye configuration?
514
+** How do I allow or require another person to approve changes to a Pluckeye configuration?
564 515
565
- See [[expedite]] or [[restricted-devices]].
516
+ See [[expedite][Expedite]] and [[restricted-devices][Restricted devices]].
566 517
567 518
** Where can I get more help and/or find more Pluckeye documentation?
568 519
569
- - [[https://manual.pluckeye.net/]] :: it has a search feature!
570
- - [[https://u.pluckeye.net/doc/help]] :: help using u.pluckeye.net
520
+ - The manual you are on right now :: it has a search feature!
571 521
- [[https://www.pluckeye.net/faq-about.html]] :: big picture questions
572 522
- [[https://www.reddit.com/r/pluckeye/]] :: community-based subreddit
573 523
- [[https://forum.pluckeye.net/]] :: a pluckeye user forum
features.org
... ...
@@ -0,0 +1,98 @@
1
+---
2
+title: Features | Pluckeye
3
+---
4
+
5
+This page describes Pluckeye's features, which cause it to behave in different ways than it normally would. All features are disabled by default.
6
+
7
+[[_TOC_|levels = 2]]
8
+
9
+* How to enable and disable features
10
+Enable or disable any feature by [[how-to-open-a-console-window][opening a console window]] and running ~pluck <+ / -> <feature>~. For example, ~pluck + nhb~.
11
+
12
+* List of features
13
+** nhb
14
+
15
+- no-holds-barred :: /a term used to describe fighting
16
+ competitions that allow dangerous maneuvers./
17
+
18
+ Makes some blocking decisions even more aggressive. Don't hold back. It has no effect if the [[system]] feature is disabled.
19
+
20
+*** v0.75 - v0.99
21
+ If you are using a version of Pluckeye between 0.75.0 and 0.99.61, there is another way to enable ~nhb~ if you are less comfortable with the console:
22
+1. Click the Pluckeye button in the top right corner of your browser.
23
+2. Click "settings" in the menu.
24
+3. Click "avanced".
25
+4. Read the description.
26
+4. Check "Enable" and click "Apply".
27
+
28
+*** v0.74.0 and older
29
+ These versions of Pluckeye had distinct nhb variants.
30
+
31
+** noapproval
32
+
33
+ Disables [[//u.pluckeye.net/][the users site]]'s approval (AKA expedite) system.
34
+
35
+** nochrome
36
+
37
+ Prevents Chrome and Chromium-based browsers such as Vivaldi from being used if the [[system]] feature is also enabled (unless [[rules#everything][allow everything]] is in effect). This is generally not suggested, as [[faq#what-browsers-does-pluckeye-work-with][Pluckeye has fuller support for these browsers than any others]].
38
+
39
+** nochromesignin
40
+ Prevents you from signing in to Chrome.
41
+
42
+** nochromesync
43
+ Prevents Chrome from syncing.
44
+
45
+** nodoh
46
+ Prevents [[//en.wikipedia.org/wiki/DNS_over_HTTPS][DNS over HTTPS]].
47
+
48
+** nofirefox
49
+
50
+ Prevents Firefox v57+ from utilizing the Pluckeye extension.
51
+
52
+** nohistoryclear
53
+ Prevents you from clearing your browser history.
54
+
55
+** okincognito
56
+ Allows Incognito Mode in Chrome.
57
+
58
+** safe
59
+ All of the following features are described in [[safe][the article for safe]]:
60
+ * ~safe~
61
+ * ~safer~
62
+ * ~safegoogle~
63
+ * ~unsafegoogle~
64
+ * ~safeplease~
65
+ * ~unsafeplease~
66
+ * ~safesites~
67
+ * ~unsafesites~
68
+ * ~safeyoutube~
69
+ * ~saferyoutube~
70
+ * ~unsafeyoutube~
71
+ * ~unsaferyoutube~
72
+
73
+** system
74
+ /Main article: [[system]]/
75
+
76
+** Legacy
77
+These features are outdated, but were used in older versions of Pluckeye.
78
+
79
+*** diedisable
80
+ Prevents removal of the browser extension.
81
+
82
+*** diedisable2
83
+ Like [[#diedisable][diedisable]] but gentler.
84
+
85
+*** diedisable3
86
+ Like [[#diedisable][diedisable]] but harsher.
87
+
88
+*** nosometime
89
+ Disables all ~sometimes~ rules (which became [[rules#when][when]] rules).
90
+
91
+*** nounbork
92
+ Disables [[commands#unbork][unbork]] (a deprecated command).
93
+
94
+*** slowsometime
95
+ Delays all ~sometimes~ rules (which became [[rules#when][when]] rules).
96
+
97
+*** slowunbork
98
+ Allows [[commands#unbork][unbork]] (a deprecated command) to wait for more than 24 hours to run.
getting-supporters.md
... ...
@@ -0,0 +1,14 @@
1
+---
2
+title: Getting supporters | Pluckeye
3
+---
4
+
5
+If you don't know what a supporter is, it's explained in the [glossary](glossary#supporter).
6
+
7
+Ideally, a supporter is a real-life trusted friend who knows you and with whom you can be completely honest. In some cases, a supporter might be your parent. If a few people along these lines come to mind, [invite them to be your supporters](https://u.pluckeye.net/invitations/new) on the user site.
8
+
9
+Alternatively, you may be able to find some supporters online. If you indicate that you want more supporters in your profile on the users site, and other users can then sign up to become your supporters.
10
+
11
+One other place to find some supporters is on one of the online forums frequented by others in a similar situation who might be motivated to review your Pluckeye configurations. The sites below were added based upon recommendations from users. If you find such a site or forum online, then tell us about it, and we can add it to the list below!
12
+
13
+* [The Pluckeye forum](https://forum.pluckeye.net/viewforum.php?id=5) lets users recruit supporters through forum posts.
14
+* [The Pluckeye subreddit](https://reddit.com/r/pluckeye) is frequented by redditors who also use Pluckeye.
glossary.md
... ...
@@ -0,0 +1,68 @@
1
+---
2
+title: Glossary | Pluckeye
3
+---
4
+
5
+[[_TOC_]]
6
+
7
+### approvee
8
+A person who uses Pluckeye, has an account on [the users site](//u.pluckeye.net/) and wants other users (their [supporters](#supporter)) to be able to approve their [expedite](expedite) requests. E.g., if Peter is one of your approvees, you can approve or reject his expedite requests.
9
+
10
+### approver
11
+A person who can approve [expedite requests](expedite) for an [approvee](#approvee) through the [the users site](//u.pluckeye.net/), but who can not see the [configurations](#configuration) of the approvee (for that, see [inspector](#inspector)).
12
+
13
+### cohort
14
+*Main article: [Cohorts](cohorts)*
15
+A group of users who have accounts on [the users site](//u.pluckeye.net/) in which all members can approve [expedite requests](expedite) for other members of the group. Expedite requests from a new member will only be approvable by the cohort after the new member's delay has elapsed.
16
+
17
+### command
18
+*Main article: [Commands](commands)*
19
+
20
+### configuration
21
+A collection of Pluckeye [rules](rules). A configuration may be *local* or *remote*. A local configuration exists only on a [device](#device). It is not synchronized with anything. A remote configuration is one that exists on [the users site](//u.pluckeye.net/), and may be assigned to a device. The configuration may then be modified either through the users site interface or on any device you own that uses the configuration. (See [Synchronizing configurations](synchronizing-configurations) for how to do this.)
22
+
23
+### delay
24
+*Main article: [The Delay](delay)*
25
+
26
+A number of seconds, minutes, hours, or days that must elapse before [configuration](#configuration) changes that allow the user more access become effective.
27
+
28
+### device
29
+A physical device such as a computer or a smart phone. Exception: Pluckeye-lite devices are merely browsers.
30
+
31
+### expedite
32
+*Main article: [Expedite](expedite)*
33
+
34
+The button a Pluckeye user pushes to request that a change to a Pluckeye [configuration](#configuration) be expedited, which means letting their [supporters](#supporter) peruse and approve the change through [the users site](//u.pluckeye.net/).
35
+
36
+### feature
37
+*Main article: [Features](feature)*
38
+
39
+### group
40
+Currently, the only type of group is a [cohort](#cohort) (so groups and cohorts are synonymous).
41
+
42
+### helper
43
+An older term for a [supporter](#supporter).
44
+
45
+### import
46
+*Main article: [Importing configurations](importing-configurations)*
47
+
48
+To cause the rules from the imported [configuration](#configuration) to be effectively added to the rules in the importing configuration.
49
+
50
+### include
51
+A synonym for [import](#import).
52
+
53
+### inspector
54
+A person or [group](#group) on [the users site](//u.pluckeye.net/) that can both see the [configurations](#configurations) of and approve [expedite requests](expedite) for an [approvee](#approvee).
55
+
56
+### restricted
57
+*Main article: [Restricted devices](restricted-devices)*
58
+
59
+A restricted [device](#device) is one that is not permitted to change its own [configuration](#configuration). Its configuration may only be changed on [the users site](//u.pluckeye.net/) by the owner of the device.
60
+
61
+### rule
62
+*Main article: [Rules](rules)*
63
+
64
+### supplication
65
+A synonym for [expedite](expedite) request.
66
+
67
+### supporter
68
+An [approver](#approver) or an [inspector](#inspector).
how-to-filter-by-time.org
... ...
@@ -1,33 +0,0 @@
1
----
2
-title: How to Filter by Time | Pluckeye
3
----
4
-
5
-* Facebook example
6
-
7
-If you would only like facebook access from 2pm to 4pm every day
8
-(14-16 in 24-hour notation), here is how you could do it with
9
-Pluckeye:
10
-
11
-#+BEGIN_SRC sh
12
- pluck + when "14-16" allow facebook.com
13
-#+END_SRC
14
-
15
-Or, more stringently:
16
-
17
-#+BEGIN_SRC sh
18
- pluck + when "0-14&16-24" block facebook.com
19
-#+END_SRC
20
-
21
-Or, for only on weekdays:
22
-
23
-#+BEGIN_SRC sh
24
- pluck + when "MTWRF0-14&16-24" block facebook.com
25
-#+END_SRC
26
-
27
-The schedule format used by scheduled rules is not well documented,
28
-but perhaps the following legend will enlighten.
29
-
30
-- UMTWRFA :: sUn, Mon, Tue, Wed, thuR, Fri, sAt
31
-
32
-See [[https://u.pluckeye.net/hrs3]] for a point and click interface for
33
-creating schedules for Pluckeye.
how-to-install.org
... ...
@@ -2,45 +2,47 @@
2 2
title: How To Install and Uninstall | Pluckeye
3 3
---
4 4
5
-If you prefer video, check out [[https://www.pluckeye.net/quickstart.html][quickstart screencasts]].
5
+If you prefer video instead of written instructions, check out the [[quickstart][quickstart screencasts]].
6 6
7
-If you prefer a written description to video, continue reading below.
7
+[[_TOC_]]
8 8
9 9
* Windows
10 10
11 11
** Installing
12 12
13
-1. Visit [[https://www.pluckeye.net/try-it.html]] .
13
+1. Visit [[https://r.pluckeye.net/try-it]].
14 14
2. Click the big "Download" button.
15
-3. In Chrome, hit Ctrl-Shift-Y to view downloads.
16
-4. Double click on the file you just downloaded (for example, pluckeye-windows-0.38.0.exe) to install Pluckeye.
17
-5. Close all instances of Chrome.
18
-6. Click "Next" in the installation wizard as necessary to install.
19
-7. Restart your browsers. You should see a button with the Pluckeye 'P' on it when Chrome restarts.
15
+3. If a window pops up, click "Save" or "Save File".
16
+3. Click on the name of the downloaded file. It will look something like "pluckeye-windows-0.99.60.exe". Where it appears depends on your browser:
17
+ - If you are using Chrome, it should appear near the bottom of the window.
18
+ - If you are using Firefox, click on the download arrow near the top right of the window. The downloaded file should appear at the top of the download list.
19
+5. Close all Chrome and Firefox windows that you have open.
20
+6. Follow the instructions in the installation wizard, clicking "Next" to proceed through each step.
21
+7. Restart your browsers. In Chrome or Firefox (or both if you have both), you should see a button with the Pluckeye 'P' on it near the top right.
20 22
21 23
** Uninstalling
22 24
23
-1. Close all Chrome windows.
24
-2. Open Add/Remove Programs in Windows. In various versions of Windows:
25
- - Control Panel > Add/Remove Programs (Windows XP)
26
- - Control Panel > Programs and Features (Vista and Windows 7)
27
- - Start button > type "uninstall", select "Uninstall a Program" (Windows 8 - 10)
25
+1. Close all Chrome and Firefox windows.
26
+2. Open Add/Remove Programs in Windows. How you do this depends on which version of Windows you are using:
27
+ - In Windows XP: Control Panel > Add/Remove Programs
28
+ - In Windows Vista or 7: Control Panel > Programs and Features
29
+ - In Windows 8, 8.1, or 10: Start button > type "uninstall" > select "Uninstall a Program"
28 30
3. Double click the entry for Pluckeye.
29 31
30 32
* Mac OS X
31 33
32
-** Install
34
+** Installing
33 35
34 36
In Chrome:
35 37
36
-1. Visit [[http://pluckeye.net/]] .
38
+1. Visit [[https://r.pluckeye.net/try-it]].
37 39
2. Click the big "Download" button.
38 40
3. Click Save File.
39
-4. Click the download arrow, and click on the downloaded file (e.g., pluckeye-macosx-0.40.1.pkg).
41
+4. Click the download arrow, and click on the downloaded file (e.g., pluckeye-macosx-0.99.60.pkg).
40 42
5. Follow the installation wizard prompts.
41 43
6. Restart your browsers.
42 44
43
-** Uninstall
45
+** Uninstalling
44 46
45 47
In Chrome:
46 48
... ...
@@ -59,35 +61,36 @@ Alternatively, at a terminal prompt:
59 61
pluck uninstall
60 62
#+END_SRC
61 63
62
-* On Linux
64
+* Linux
63 65
64 66
** Installing
65 67
66 68
*** Step 1: Download
69
+
67 70
In Chrome:
68 71
69
-1. Visit [[http://www.pluckeye.net/try-it.html]] .
72
+1. Visit [[https://r.pluckeye.net/try-it]].
70 73
2. Click the big "Download" button.
71
-3. Save File, and note the save location (this is usually the Downloads folder) and the file name (e.g., pluckeye-linux-0.36.1.tar.gz).
74
+3. Save the file, noting where you save it (usually the Downloads folder) and the file name (e.g., pluckeye-linux-0.99.60.tar.gz).
72 75
73
-*** Step 2: Extract & Run Install File
76
+*** Step 2: Extract and run the installer
74 77
75
-**** Example 1: Extracting with default unarchiver
78
+**** Method 1: Extracting with the default unarchiver
76 79
77
-a. Navigate to your computer’s “Downloads” folder.
80
+a. Navigate to where you saved the file (often your computer's "Downloads" folder).
78 81
79
-b. Right click the Pluckeye file and select “Extract Here.” Once the extraction is complete, you should see a new file named something like pluckeye-linux*.installer.
80
-(If you can’t find the file, check your browser’s settings to see which folder is set to contain your downloads. If your browser is set to save files in the Downloads folder, download Pluckeye again, but this time be sure to click “Save File” instead of “Open With.”)
82
+b. Right click the Pluckeye file and select "Extract Here". Once the extraction is complete, you should see a new file named something like pluckeye-linux*.installer. (If you can't find the file, check your browser's settings to see which folder is set to contain your downloads. If your browser is set to save files in the Downloads folder, download Pluckeye again, but this time be sure to click "Save File" instead of "Open With".)
81 83
82
-c. Right click a blank space in the Downloads folder and select “Open in Terminal”. This will open a Terminal window in the Downloads folder.
84
+c. Right click in the blank space in the folder where you saved the file and select "Open in Terminal". This will open a terminal window in the folder.
83 85
84
-d. In the Terminal window, type the following and press enter: =sudo ~/Downloads/pluckeye-linux*.installer=
85
-Type your password and press enter. (Replace the asterisk with the version number in the original file name, e.g. /pluckeye-linux-0.95.9.installer/.)
86
+d. In the terminal window, type: =sudo ./pluckeye-linux*.installer= and press enter. Type your password and press enter. (Replace the asterisk with the version number in the original file name, e.g. =./pluckeye-linux-0.99.60.installer=.)
86 87
87 88
***** Help
88
-- "I right-clicked the file, but there was no 'Extract Here' option." (Your windows manager may not have a built-in unarchiver. See the examples below for other alternatives.)
89
+- "I right-clicked the file, but there was no 'Extract Here' option."
89 90
90
-**** Example 2: Extracting with 7-Zip
91
+ Your windows manager may not have a built-in unarchiver. See the examples below for other alternatives.
92
+
93
+**** Method 2: Extracting with 7-Zip
91 94
92 95
a. [[how-to-open-a-console-window][Open a terminal]].
93 96
... ...
@@ -97,19 +100,25 @@ b. In the terminal, extract using 7-Zip (7z).
97 100
7z x pluckeye-linux-*.**.*.tar.gz
98 101
#+END_EXAMPLE
99 102
100
-(/Replace the asterisks in the example to match the file name of your downloaded Pluckeye file/.)
103
+ (/Replace the asterisks in the example to match the file name of your downloaded Pluckeye file/.)
101 104
102 105
c. In the same terminal window, run the extracted install file.
103 106
#+BEGIN_EXAMPLE
104 107
sudo ~/Downloads/pluckeye-linux-*.**.*.installer
105 108
#+END_EXAMPLE
106
-(/Replace the asterisks in the example to match the current version numbers as before/.)
109
+
110
+ (/Replace the asterisks in the example to match the current version numbers as before/.)
107 111
108 112
***** Help
109
-- "I don't have 7-Zip." (In Debian & Ubuntu, install 7-Zip by typing =sudo apt install p7zip-full= in the terminal. See [[https://www.ibm.com/developerworks/community/blogs/6e6f6d1b-95c3-46df-8a26-b7efd8ee4b57/entry/how_to_use_7zip_on_linux_command_line144?lang=en][this tutorial page]] for more.)
110
-- "I don't have sudo." (Ubuntu has sudo installed by default, but Debian doesn't. See [[https://unix.stackexchange.com/questions/360813/how-to-install-sudo-command-in-debian][this page]] for more. In the meantime, you can get around sudo by installing as root by entering =su root= in the terminal before running the installer, although this is not recommended. Running terminal commands as root can damage your system if done incorrectly.)
113
+- "I don't have 7-Zip." (This is the case if your terminal says =7z: command not found=.)
111 114
112
-**** Example 3: Using Tar Command
115
+ In Debian or Ubuntu, you can install 7-Zip by typing =sudo apt install p7zip-full= in the terminal. See [[https://www.ibm.com/developerworks/community/blogs/6e6f6d1b-95c3-46df-8a26-b7efd8ee4b57/entry/how_to_use_7zip_on_linux_command_line144?lang=en][this tutorial page]] for more.
116
+
117
+- "I don't have sudo." (This is the case if your terminal says =sudo: command not found=.)
118
+
119
+ Ubuntu has sudo installed by default, but Debian doesn't. See [[https://unix.stackexchange.com/questions/360813/how-to-install-sudo-command-in-debian][this page]] for more. In the meantime, you can get around sudo by installing as root by entering =su root= (and pressing enter) in the terminal before running the installer, although this is not recommended. Running terminal commands as root can damage your system if done incorrectly.
120
+
121
+**** Method 3: Using Tar Command
113 122
114 123
a. [[how-to-open-a-console-window][Open a terminal]].
115 124
... ...
@@ -123,8 +132,7 @@ b. In the terminal:
123 132
sudo ./pluckeye*.installer
124 133
#+END_SRC
125 134
126
- Here is an example terminal session in which jon installs
127
- pluckeye-0.36.1 on his Ubuntu computer named theodore.
135
+ Here is an example terminal session in which Jon installs pluckeye-0.36.1 on his Ubuntu computer named theodore:
128 136
129 137
#+BEGIN_EXAMPLE
130 138
jon@theodore:~$ cd /tmp
... ...
@@ -142,19 +150,19 @@ b. In the terminal:
142 150
143 151
3. Restart your browsers.
144 152
145
-** Uninstall
153
+** Uninstalling
146 154
147 155
1. [[how-to-open-a-console-window.org][Open a terminal]].
148 156
149 157
2. In the terminal:
150 158
151
- First set the delay to 0
159
+ First set the delay to 0:
152 160
153 161
#+BEGIN_SRC sh
154 162
pluck delay 0
155 163
#+END_SRC
156 164
157
- Once the delay becomes 0, then uninstall.
165
+ Once your old delay has elapsed, then the delay will become 0 and you can uninstall:
158 166
159 167
#+BEGIN_SRC sh
160 168
pluck export | grep -i delay
how-to-open-a-console-window.org
... ...
@@ -2,16 +2,9 @@
2 2
title: How to Open a Console | Pluckeye
3 3
---
4 4
5
-- [[#what-is-a-windows-console][Windows]]
6
- - [[#what-is-a-windows-console_windows-key-r][Windows Key + R]]
7
-- [[#what-is-a-mac-terminal][Mac OS X]]
8
- - [[#what-is-a-mac-terminal_use-finder-utilities-terminal][Use Finder > Utilities > Terminal]]
9
-- [[#what-is-a-linux-terminal][Linux]]
10
- - [[#what-is-a-linux-terminal_ctrl-alt-t-on-ubuntu-and-ubuntu-like-systems][Ctrl+Alt+T on Ubuntu & Ubuntu-like systems]]
11
- - [[#what-is-a-linux-terminal_ctrl-alt-4-on-zorin][Ctrl+Alt+4 on Zorin]]
12
-- [[#want-more-help-with-the-console-and-pluckeye][Additional Help]]
5
+[[_TOC_]]
13 6
14
-* What is a Windows Console?
7
+* Windows
15 8
16 9
Note that "console", "terminal", and "command prompt" are used
17 10
interchangeably because they all mean the same thing. Here is what
... ...
@@ -29,7 +22,7 @@ title: How to Open a Console | Pluckeye
29 22
30 23
<<Video(https://static.pluckeye.net/videos/windows/console-windows-10.webm)>>
31 24
32
-* What is a Mac Terminal?
25
+* Mac OS X
33 26
34 27
When this site uses the term /console/, it really means /terminal/
35 28
on Mac OS X. Here is what one looks like (one will look slightly
... ...
@@ -43,7 +36,7 @@ title: How to Open a Console | Pluckeye
43 36
44 37
See [[http://www.wikihow.com/Get-to-the-Command-Line-on-a-Mac]].
45 38
46
-* What is a Linux Terminal?
39
+* Linux
47 40
48 41
Here is what one looks like (one will look slightly different on
49 42
your computer):
importing-configurations.md
... ...
@@ -0,0 +1,21 @@
1
+---
2
+title: Importing configurations | Pluckeye
3
+---
4
+
5
+Imports are a powerful feature in Pluckeye configurations. This page shows a couple examples of how they might be used.
6
+
7
+## Example 1: Susan's books
8
+
9
+Susan likes to research books on the Internet. She also uses Pluckeye. Over time, Susan has added to her Pluckeye configuration a large number of links to children's books on [Goodreads](https://www.goodreads.com/) that she thinks would be useful to other Pluckeye users who also like children's books. To do this, she creates a [new configuration](https://u.pluckeye.net/configurations/new) of type "allowed urls", and names it "Susan's approved children's books". She then edits the configuration, copying in all the urls she has accumulated over her Pluckeye history, and saves the configuration. After saving it, she clicks "Share" and "Publish" to share the configuration with all Pluckeye users.
10
+
11
+Peter, another Pluckeye user, sees Susan's configuration in the [list of public configurations](https://u.pluckeye.net/configurations/public). Peter views the configuration and clicks the import button. When prompted for which configuration to add it to, he selects his one and only configuration. After his delay elapses, Peter then inherits Susan's list of approved books.
12
+
13
+Later, Susan adds more books to her public configuration. These changes automatically propagate to Peter's computer. If Peter decides he no longer wants to use Susan's list, he can remove the import rule for "Susan's approved children's books".
14
+
15
+## Example 2: A Reddit Subreddit blacklist
16
+
17
+u/cocucu, a Reddit user, has written a program that crawls Reddit and identifies not-safe-for-work (NSFW) subreddits. He takes the output of his script and creates a new configuration of type "blocked urls". He then makes public the configuration so that other Pluckeye users may import it into their configurations.
18
+
19
+## Example 3: Work/Play configurations
20
+
21
+Edmund uses Pluckeye to keep himself from being distracted from schoolwork during certain hours of the day. But in the evenings, he likes to allow himself more liberal use of the Internet. So, he creates a new configuration of type "general" and gives it the name "work". He creates a second new configuration and names it "play". Edmund then adds an import rule to his original configuration so that it will import from "work" during the hours of 9am to 5pm, and another import rule so that it will import from the "play" configuration during the hours from 5pm to 8pm.
legacy.org
... ...
@@ -20,7 +20,7 @@ v0.99. This page documents some of those changes.
20 20
| block (unadorned) | block otherwise | |
21 21
| level 1 | | |
22 22
| level 2 | system | level 2 is now controlled by the feature named "system" |
23
- | registration | N/A | See [[https://u.pluckeye.net/doc/synchronize-configurations][configuration synchronization]] and [[https://u.pluckeye.net/doc/get-supporters][supporters]]. |
23
+ | registration | N/A | See [[synchronizing-configurations][configuration synchronization]] and [[https://u.pluckeye.net/doc/get-supporters][supporters]]. |
24 24
| program calc blackout | block program:calc | |
25 25
| | allow user:jane | |
26 26
| deny | block | |
levels.org
... ...
@@ -1,96 +0,0 @@
1
----
2
-title: Installation Levels | Pluckeye
3
----
4
-
5
-* Terms
6
-
7
-- Level 0 :: The Pluckeye extension for Firefox or Chrome is
8
- installed from the [[https://addons.mozilla.org/en-US/firefox/][Mozilla Add-ons]] site or from the
9
- [[https://chrome.google.com/webstore/category/extensions][Chrome Web Store]]. As long as the extension is enabled,
10
- images will be blocked within Firefox or Chrome: no
11
- whitelist, no blacklist, no configuration, no options.
12
-
13
-- Level 1 :: Level 1 is the default when Pluckeye is first installed
14
- from the [[https://www.pluckeye.net/try-it.html][try it page]]. Level 1 includes system
15
- binaries as well as the Pluckeye extensions for Firefox
16
- and Chrome. As long as the extension is enabled, level
17
- 1 allows use of most Pluckeye features in Firefox or
18
- Chrome including whitelisting, blacklisting, scheduled
19
- rules and more. Level 1 is suitable for trying
20
- Pluckeye without firmly locking down one's Internet
21
- access.
22
-
23
-- Level 2 :: Also known as *self-control mode*, level 2 prevents the
24
- user from easily bypassing Pluckeye. In addition to
25
- Firefox and Chrome, other browsers on the computer such
26
- as Safari and Internet Explorer are filtered or
27
- blocked. See the platform notes below. The author
28
- originally expected that most users would use level 2.
29
-
30
-* Why isn't level 2 the default?
31
-
32
-Level 1 is the default level mainly as a safety measure. By
33
-requiring the user to set the level manually, the user is then
34
-educated on how to do the reverse as well. And some users find
35
-level 1 to be sufficient help for themselves.
36
-
37
-* Platform notes
38
-
39
-*** Level 2 on Windows
40
-
41
-On Windows, level 2 means that only Firefox, Chrome, and browsers
42
-based on them (e.g. Brave) may be used for browsing the Internet;
43
-Internet Explorer, Microsoft Edge, and all other browsers other
44
-than Firefox and Chrome *will not work at all*.
45
-
46
-*** Level 2 on Linux
47
-
48
-On Linux, level 2 means that browsers other than Firefox and
49
-Chromium will be slower, overblock the user, and generally be much
50
-less useful than Firefox and Chromium. But they will still work
51
-in general. Well, with one big exception:
52
-[[known-issues.org][Chrome will not work at all, but Chromium
53
-should with Pluckeye 0.50.0 or greater]].
54
-
55
-* How to change the installation level
56
-
57
-*** Method 1, Firefox or Chrome
58
-
59
-Firefox or Chrome > Pluckeye Button > Settings button > Set Delay to 0 > Change level
60
-
61
-See also [[https://www.pluckeye.net/quickstart.html#installation-levels][this video]].
62
-
63
-*** Method 2, command line
64
-
65
-**** Windows
66
-
67
-#+BEGIN_EXAMPLE
68
-C:\> pluck set "delay 0"
69
-. . . wait until delay setting has taken effect . . .
70
-C:\> pluck set "level 2"
71
-#+END_EXAMPLE
72
-
73
-
74
-**** Mac OS X
75
-
76
-#+BEGIN_SRC sh
77
- pluckeye_delay=$(pluck export | awk '/^Delay/ { print $2 }')
78
- pluck set "delay 0"
79
- sleep $pluckeye_delay
80
- pluck set "level 2"
81
-#+END_SRC
82
-
83
-**** Linux
84
-
85
-#+BEGIN_SRC sh
86
- pluckeye_delay=$(pluck export | awk '/^Delay/ { print $2 }')
87
- pluck set "delay 0"
88
- sleep $pluckeye_delay
89
- pluck set "level 2"
90
-#+END_SRC
91
-
92
-* tl;dr
93
-
94
-1. Install both [[https://www.mozilla.org/en-US/firefox/new][Firefox]] and [[https://www.google.com/chrome][Chrome]] (or [[http://www.chromium.org/][Chromium]] and not Chrome on Linux).
95
-2. Use level 2.
96
-3. Get Pluckeye [[https://www.pluckeye.net/try-it.html][here]].
notation.org
... ...
@@ -17,9 +17,9 @@ or this
17 17
#+END_EXAMPLE
18 18
19 19
The dollar-sign, if present, is a unix-based convention to indicate
20
-a [[how-to-open-a-console-window.org][console window]] prompt. Everything following the $ , but *not* the
21
-$ itself, is to be typed in a [[how-to-open-a-console-window.org][console window]] (a.k.a., a terminal).
22
-In this case, a [[how-to-open-a-console-window.org][console window]] should be opened, and the user should
20
+a [[how-to-open-a-console-window][console window]] prompt. Everything following the $ , but *not* the
21
+$ itself, is to be typed in a console window (a.k.a., a terminal).
22
+In this case, a console window should be opened, and the user should
23 23
type
24 24
25 25
#+BEGIN_SRC sh
... ...
@@ -52,4 +52,4 @@ each line:
52 52
53 53
** What's a console window?
54 54
55
-See [[how-to-open-a-console-window.org]].
55
+See [[how-to-open-a-console-window.org][how to open a console window]].
old-and-inaccurate/levels.org
... ...
@@ -0,0 +1,96 @@
1
+---
2
+title: Installation Levels | Pluckeye
3
+---
4
+
5
+* Terms
6
+
7
+- Level 0 :: The Pluckeye extension for Firefox or Chrome is
8
+ installed from the [[https://addons.mozilla.org/en-US/firefox/][Mozilla Add-ons]] site or from the
9
+ [[https://chrome.google.com/webstore/category/extensions][Chrome Web Store]]. As long as the extension is enabled,
10
+ images will be blocked within Firefox or Chrome: no
11
+ whitelist, no blacklist, no configuration, no options.
12
+
13
+- Level 1 :: Level 1 is the default when Pluckeye is first installed
14
+ from the [[https://www.pluckeye.net/try-it.html][try it page]]. Level 1 includes system
15
+ binaries as well as the Pluckeye extensions for Firefox
16
+ and Chrome. As long as the extension is enabled, level
17
+ 1 allows use of most Pluckeye features in Firefox or
18
+ Chrome including whitelisting, blacklisting, scheduled
19
+ rules and more. Level 1 is suitable for trying
20
+ Pluckeye without firmly locking down one's Internet
21
+ access.
22
+
23
+- Level 2 :: Also known as *self-control mode*, level 2 prevents the
24
+ user from easily bypassing Pluckeye. In addition to
25
+ Firefox and Chrome, other browsers on the computer such
26
+ as Safari and Internet Explorer are filtered or
27
+ blocked. See the platform notes below. The author
28
+ originally expected that most users would use level 2.
29
+
30
+* Why isn't level 2 the default?
31
+
32
+Level 1 is the default level mainly as a safety measure. By
33
+requiring the user to set the level manually, the user is then
34
+educated on how to do the reverse as well. And some users find
35
+level 1 to be sufficient help for themselves.
36
+
37
+* Platform notes
38
+
39
+*** Level 2 on Windows
40
+
41
+On Windows, level 2 means that only Firefox, Chrome, and browsers
42
+based on them (e.g. Brave) may be used for browsing the Internet;
43
+Internet Explorer, Microsoft Edge, and all other browsers other
44
+than Firefox and Chrome *will not work at all*.
45
+
46
+*** Level 2 on Linux
47
+
48
+On Linux, level 2 means that browsers other than Firefox and
49
+Chromium will be slower, overblock the user, and generally be much
50
+less useful than Firefox and Chromium. But they will still work
51
+in general. Well, with one big exception:
52
+[[known-issues.org][Chrome will not work at all, but Chromium
53
+should with Pluckeye 0.50.0 or greater]].
54
+
55
+* How to change the installation level
56
+
57
+*** Method 1, Firefox or Chrome
58
+
59
+Firefox or Chrome > Pluckeye Button > Settings button > Set Delay to 0 > Change level
60
+
61
+See also [[https://www.pluckeye.net/quickstart.html#installation-levels][this video]].
62
+
63
+*** Method 2, command line
64
+
65
+**** Windows
66
+
67
+#+BEGIN_EXAMPLE
68
+C:\> pluck set "delay 0"
69
+. . . wait until delay setting has taken effect . . .
70
+C:\> pluck set "level 2"
71
+#+END_EXAMPLE
72
+
73
+
74
+**** Mac OS X
75
+
76
+#+BEGIN_SRC sh
77
+ pluckeye_delay=$(pluck export | awk '/^Delay/ { print $2 }')
78
+ pluck set "delay 0"
79
+ sleep $pluckeye_delay
80
+ pluck set "level 2"
81
+#+END_SRC
82
+
83
+**** Linux
84
+
85
+#+BEGIN_SRC sh
86
+ pluckeye_delay=$(pluck export | awk '/^Delay/ { print $2 }')
87
+ pluck set "delay 0"
88
+ sleep $pluckeye_delay
89
+ pluck set "level 2"
90
+#+END_SRC
91
+
92
+* tl;dr
93
+
94
+1. Install both [[https://www.mozilla.org/en-US/firefox/new][Firefox]] and [[https://www.google.com/chrome][Chrome]] (or [[http://www.chromium.org/][Chromium]] and not Chrome on Linux).
95
+2. Use level 2.
96
+3. Get Pluckeye [[https://www.pluckeye.net/try-it.html][here]].
options.org
... ...
@@ -1,197 +0,0 @@
1
----
2
-title: Options | Pluckeye
3
----
4
-
5
-* TODO: fix this page
6
-
7
- This page should be renamed to "commands" or "list-of-commands", and
8
- an example given along with commentary for all Pluckeye commands.
9
-
10
- Beginners should be redirected to [[command-line-basics]], while
11
- advanced users should be able to use this page as a quick reference
12
- for pluckeye syntax in accomplishing various tasks.
13
-
14
- Some related resources that should be at hand when editing this page
15
- include =pluck more-help=, [[rule-syntax]],
16
- [[https://wiki.pluckeye.net/Home]] (written by Iván) , and
17
- [[command-line-basics]].
18
-
19
- Legacy features and terminology (such as nosometimes, set,
20
- slowsometime, and the like) should be moved to a legacy-specific
21
- section to help those who see those terms and don't know that they
22
- are legacy, or what their modern equivalents are.
23
-
24
-/Please note that this page is still incomplete./
25
-
26
-/To search this page by keyword, use/ *Ctrl + F* /on Windows & Linux or/ *Command + F* /on Mac./
27
-
28
-* abort
29
-
30
-Aborts a pending rule change.
31
-
32
-#+BEGIN_EXAMPLE
33
-pluck abort [pattern]
34
-#+END_EXAMPLE
35
-
36
-* allow
37
-
38
-Allows a specified website, page, or application.
39
-#+BEGIN_EXAMPLE
40
-pluck + allow [website/application]
41
-#+END_EXAMPLE
42
-
43
-* block
44
-
45
-Blocks a specified website, page, or application.
46
-#+BEGIN_EXAMPLE
47
-pluck + block [website/application]
48
-#+END_EXAMPLE
49
-
50
-* blackout
51
-
52
-Disables all Internet access; often coupled with a [[sometimes]] or "when" setting. The following example schedules a daily blackout from midnight to 6am and from 9pm (21:00) to midnight.
53
-#+BEGIN_EXAMPLE
54
-pluck + when 0-6&21-24 block everything
55
-#+END_EXAMPLE
56
-
57
-* clear
58
-
59
-Allows all websites. (Mostly useful if you need to block only a select few, but allow access to everything else.)
60
-
61
-#+BEGIN_EXAMPLE
62
-pluck clear
63
-#+END_EXAMPLE
64
-
65
-* delay
66
-
67
-Sets the delay that must expire before any permissive rules (i.e. rules that allow rather than block) go into effect. Below are given examples of how you set a delay for zero seconds (delay 0), 1 hour (3600s, 60m, 1h), and 1 day (1d).
68
-#+BEGIN_EXAMPLE
69
-pluck delay 0
70
-pluck delay 3600s
71
-pluck delay 60m
72
-pluck delay 1h
73
-pluck delay 1d
74
-#+END_EXAMPLE
75
-
76
-* del (delete/revert/remove rule)
77
-
78
-Deletes a rule. For example, if you delete a =block= rule for a given site, Pluckeye reverts to the default setting of blocking images & video while allowing pages to otherwise load. (An exception to this rule occurs if you have conflicting rules already in place. For instance, if you have =allow google.com= and =block google.com=, the block rule overrides the allow rule. If the block rule is deleted, the allow rule succeeds. If the allow rule is also deleted, the default rule succeeds and blocks images & video whole allowing the site to otherwise load.)
79
-
80
-#+BEGIN_EXAMPLE
81
-pluck - [rule to remove]
82
-
83
-Example:
84
-pluck - allow google.com
85
-#+END_EXAMPLE
86
-
87
-The old syntax (rm) and (del) is being depreciated. The new syntax, the minus sign (-), is preferred.
88
-
89
-* eval
90
-
91
-Evaluates the rule settings on a given site or application, and can be used to troubleshoot why something is or isn't loading or being displayed. Note that merely giving a website will tell you whether the website will load, not whether the images are allowed. Thus, under default settings, most websites will load, albeit without images. Thus, in Example 1, the =pluck eval google.com= command returns a value of =allow= because under default settings google.com is allowed to load as a webpage. However, Example 2 returns a value of =block= because now =image/= introduces a condition to inquire whether images are allowed on google.com, which are blocked under default settings.
92
-
93
-#+BEGIN_EXAMPLE
94
--Example 1-
95
-C:> pluck eval google.com
96
-allow because of rule 330: allow
97
-
98
--Example 2-
99
-C:> pluck eval google.com image/
100
-block because of rule 420: block image/
101
-#+END_EXAMPLE
102
-
103
-* export
104
-
105
-Exports Pluckeye settings as a readable text file. The examples below demonstrate how to create a settings file on the Desktop. (For more, see [[Using-Pluckeye#exporting-settings][Exporting Settings]] on the [[Using-Pluckeye][Using Pluckeye]] page.
106
-
107
-#+BEGIN_EXAMPLE
108
-Windows:
109
-cd Desktop
110
-pluck export > pluckeye-settings.txt
111
-
112
-MacOS & Linux:
113
-cd ~/Desktop
114
-pluck export > pluckeye-settings.txt
115
-#+END_EXAMPLE
116
-
117
-* factory reset
118
-
119
-Resets Pluckeye to its "factory" settings (i.e. as if you had just installed for the first time). (Note that your current settings will be lost. If you plan to reuse or restore your current settings, make sure you export and save them to a settings file before performing the factory reset.)
120
-
121
-#+BEGIN_EXAMPLE
122
-pluck factoryreset
123
-#+END_EXAMPLE
124
-
125
-* import
126
-
127
-Overrides current settings and imports a settings file. See [[Using-Pluckeye#3-then-on-the-destination-computer-import-the-settings][Importing Settings]] on the [[Using-Pluckeye][Using Pluckeye]] page for more.
128
-
129
-(Before entering the command below, first open the terminal in the directory/folder containing the pluckeye-settings.txt file.)
130
-
131
-#+BEGIN_EXAMPLE
132
-pluck import pluckeye-settings.txt
133
-#+END_EXAMPLE
134
-
135
-* nhb
136
-
137
-- No-Holds-Barred :: /a term used to describe fighting
138
- competitions that allow dangerous maneuvers./
139
-
140
-Make some blocking decisions even more aggressive. Don't hold back.
141
-It only has effect at level 2.
142
-
143
-Pluckeye up through release 0.74.0 had distinct nhb variants.
144
-Pluckeye 0.75.0 and on have an nhb option that can be set using the
145
-Pluckeye button > Settings > Advanced, or using the command line.
146
-
147
-#+BEGIN_SRC sh
148
- pluck + nhb
149
-#+END_SRC
150
-
151
-* noapproval
152
-
153
-Disable the approval system.
154
-
155
-* nochrome
156
-
157
-Do not allow Chrome, or Chromium-based browser such as Vivaldi to be
158
-used at level 2 (unless a whiteout is in effect).
159
-
160
-* nofirefox
161
-
162
-Prevents firefox 57+ from utilizing the Pluckeye extension.
163
-
164
-* nosometime
165
-
166
-Disables all sometimes rules.
167
-
168
-* set
169
-
170
-A depreciated command. Example:
171
-#+BEGIN_EXAMPLE
172
-pluck set "delay 0"
173
-#+END_EXAMPLE
174
-
175
-Using "set" is no longer preferred for changing delay settings. The current usage is =pluck delay 0=.
176
-
177
-* slowsometime
178
-
179
-Like [[nosometime]], except that it changes the delay algorithm used for
180
-sometimes rules rather than making all sometimes rules ineffective.
181
-In particular, all sometimes rule will be delayed with this option.
182
-
183
-* slowunbork
184
-
185
-Allows unbork to wait for more than 24 hours to run.
186
-
187
-* system (level 2)
188
-
189
-* when (sometimes)
190
-
191
-Do something according to a [[https://u.pluckeye.net/hrs3][schedule]]. E.g,
192
-
193
-#+BEGIN_SRC sh
194
- pluck add "sometimes MWF0-8 blackout"
195
-#+END_SRC
196
-
197
-* whiteout
quickstart.org
... ...
@@ -0,0 +1,75 @@
1
+---
2
+title: Quickstart | Pluckeye
3
+---
4
+
5
+ The following videos show how to perform some of the most common operations in Pluckeye. You can also perform these operations [[console][using a console]] if that's more your style. The videos were made with older versions of Pluckeye, so you may notice some differences with modern Pluckeye. For example, the Pluckeye button in Firefox is no longer an image of an eyeball; it is a blue "P". And the "pluckui" program has been replaced with "pluck". Nevertheless, the videos are still instructive as most of the functionality shown in the videos is still the same as when the videos were made.
6
+
7
+ If you do not know how to rewind web videos, please first start with [[quickstart-basics][the basics]].
8
+
9
+[[_TOC_]]
10
+
11
+* Windows
12
+
13
+** Installing
14
+
15
+[[how-to-install#installing][Click here for textual instructions]].
16
+
17
+<<Video(https://www.pluckeye.net/videos/windows/install-windows-2016-09-19.ogv)>>
18
+
19
+** Uninstalling
20
+
21
+[[how-to-install#uninstalling][Click here for textual instructions]].
22
+
23
+<<Video(https://www.pluckeye.net/videos/windows/uninstall-2016-09-16.ogv)>>
24
+
25
+** Changing the delay
26
+<<Video(https://www.pluckeye.net/videos/windows/delay-2016-09-16.ogv)>>
27
+
28
+** Allowing all content for a site
29
+<<Video(https://www.pluckeye.net/videos/windows/pluckeye-whitelist-windows-7-0.28.0.ogv)>>
30
+
31
+** Installation level 2, a.k.a. not just Firefox and Chrome
32
+<<Video(https://www.pluckeye.net/videos/windows/pluckeye-installation-level-0.25.1.ogv)>>
33
+
34
+* Mac OS X
35
+
36
+** Installing
37
+[[how-to-install#installing-1][Click here for textual instructions]].
38
+
39
+<<Video(https://www.pluckeye.net/videos/macosx/install.m4v)>>
40
+
41
+** Uninstalling
42
+[[how-to-install#uninstalling-1][Click here for textual instructions]].
43
+
44
+<<Video(https://www.pluckeye.net/videos/macosx/uninstall-2016-09-16.ogv)>>
45
+
46
+** Changing the delay
47
+<<Video(https://www.pluckeye.net/videos/macosx/delay-2016-09-16.ogv)>>
48
+
49
+** Allowing all content for a site
50
+<<Video(https://www.pluckeye.net/videos/macosx/pluckeye-whitelist-0.12.0.ogv)>>
51
+
52
+** Installation level 2, a.k.a. not just Firefox and Chrome
53
+
54
+<<Video(https://www.pluckeye.net/videos/macosx/pluckeye-installation-level-0.25.1.ogv)>>
55
+
56
+* Linux
57
+
58
+** Installing
59
+[[how-to-install#installing-2][Click here for textual instructions]].
60
+
61
+<<Video(https://www.pluckeye.net/videos/linux/install-2016-09-16.ogv)>>
62
+
63
+** Uninstalling
64
+[[how-to-install#uninstalling-2][Click here for textual instructions]].
65
+
66
+<<Video(https://www.pluckeye.net/videos/linux/uninstall-2016-09-16.ogv)>>
67
+
68
+** Changing the delay
69
+<<Video(https://www.pluckeye.net/videos/linux/delay-2016-09-16.ogv)>>
70
+
71
+** Allowing all content for a site
72
+<<Video(https://www.pluckeye.net/videos/linux/pluckeye-whitelist-0.12.0.ogv)>>
73
+
74
+** Installation level 2, a.k.a. not just Firefox and Chrome
75
+<<Video(https://www.pluckeye.net/videos/linux/pluckeye-installation-level-0.25.1.ogv)>>
restricted-devices.org
... ...
@@ -1,12 +1,14 @@
1 1
---
2
-title: Pluckeye restricted devices
2
+title: Restricted devices | Pluckeye
3 3
---
4 4
5
-Restricted devices are intended for other control rather than self
6
-control, and is similar to traditional parental controls. If you're
7
-seeking "password protection", this is the page for you.
5
+ Restricting a device is intended for other control rather than self control, and is similar to traditional parental controls. If you're seeking "password protection", this is the page for you.
8 6
9
-See also [[family]].
7
+ **This feature does not work before Pluckeye v0.99.42!**
8
+
9
+ The child *need not* and probably should not have an account on [[//u.pluckeye.net/][the users site]].
10
+
11
+ /See also: [[family]]/
10 12
11 13
* Overview
12 14
... ...
@@ -21,53 +23,39 @@ See also [[family]].
21 23
and both he and Susan think life would be better if she were in
22 24
charge of Edmund's Pluckeye configuration. Here's how they do it.
23 25
24
- Note that if Edmund already has an account on
25
- https://u.pluckeye.net/ , then the following instructions won't work
26
- unless Edmund first deletes his account and then sends a [[https://contact.pluckeye.net/][message to
27
- Jon]] to request that his device be liberated.
26
+ Note that if Edmund already has an account on [[//u.pluckeye.net/][the users site]], then the following instructions won't work unless Edmund first deletes his account and then sends a [[https://contact.pluckeye.net/][message to Jon]] to request that his device be liberated.
28 27
29
- 1. Susan [[how-to-install][installs Pluckeye]] on Edmund's computer if it isn't already
30
- installed.
28
+ 1. Susan [[how-to-install][installs Pluckeye]] on Edmund's computer if it isn't already installed.
31 29
32
- 2. Susan creates an account for herself on [[https://u.pluckeye.net/]].
30
+ 2. Susan creates an account for herself on [[//u.pluckeye.net/][the users site]].
33 31
34
- 3. Susan logs into [[https://u.pluckeye.net/]] as Susan using Edmund's
35
- computer. The website informs Susan that she now owns Edmund's
36
- device.
32
+ 3. Susan logs into the users site as Susan using Edmund's computer. The website informs Susan that she now owns Edmund's device.
37 33
38
- 4. Susan navigates to the webpage for the device by clicking on her
39
- name in the upper right hand corner of the page, selecting
40
- profile, and on her profile page, clicking on the computer name.
34
+ 4. Susan navigates to the webpage for the device by clicking on her name in the upper right hand corner of the page, selecting profile, and on her profile page, clicking on the computer name.
41 35
42
- TODO: screenshot here
36
+ # TODO: screenshot here
43 37
44 38
5. Susan creates a new general configuration for Edmund's device.
45 39
46
- 6. Susan configures the new configuration. She decides to import
47
- [[https://u.pluckeye.net/configurations/public][the classic]] and [[https://u.pluckeye.net/configurations/24080][the no programs]] configurations to start. She
48
- also enables the system feature in the main configuration by typing:
40
+ 6. Susan configures the new configuration. She decides to import [[//u.pluckeye.net/configurations/public][the classic]] and [[//u.pluckeye.net/configurations/24080][the no programs]] configurations to start. She also enables the system feature in the main configuration by typing:
49 41
50
- #+BEGIN_EXAMPLE
51
- feature:system
52
- #+END_EXAMPLE
42
+#+BEGIN_EXAMPLE
43
+feature:system
44
+#+END_EXAMPLE
53 45
54 46
in the edit tab of the configuration.
55 47
56 48
7. Susan clicks the red "restrict" button.
57 49
58
- 8. Susan runs this command on the computer in a cmd.exe window:
50
+ 8. Susan runs this command on the computer in a [[how-to-open-a-console-window][console window]]:
59 51
60
- #+BEGIN_EXAMPLE
61
- pluck sync
62
- #+END_EXAMPLE
52
+#+BEGIN_EXAMPLE
53
+pluck sync
54
+#+END_EXAMPLE
63 55
64 56
9. Susan restarts the computer.
65 57
66
- After performing the above steps, the allow and block buttons will
67
- not change the device configuration. Instead they will submit
68
- [[suggestions]] that Susan may approve or reject. Susan can now
69
- configure Edmund's device by simply logging into
70
- https://u.pluckeye.net/ from any computer she likes.
58
+ After performing the above steps, the allow and block buttons will not change the device configuration. Instead they will submit [[suggestions]] that Susan may approve or reject. Susan can now configure Edmund's device by simply logging into the users site from any computer she likes.
71 59
72 60
* Alternatives
73 61
rules.org
... ...
@@ -0,0 +1,145 @@
1
+---
2
+title: Rules | Pluckeye
3
+---
4
+
5
+ Pluckeye rules change what you are able to access over the Internet, and which programs are allowed to access the Internet. They live in your Pluckeye configuration. Rules are different than [[commands]].
6
+
7
+[[_TOC_|levels = 2]]
8
+
9
+* How to add a rule
10
+If you are new to Pluckeye, note that some rule changes will be subject to your [[delay]].
11
+
12
+** Through the browser extension
13
+*** v1.0
14
+1. Visit the page that you want to add a rule for in your browser. If you are not comfortable doing this, you can use one of the other methods below.
15
+1. Click the Pluckeye button in the top right of your Internet browser.
16
+2. Use the drop down menus to specify what the rule should be. Click "advanced" for additional options.
17
+3. Click the button immediately below "New Rule" that is labelled with your new rule.
18
+
19
+*** v0.99 and older
20
+If you want to add a fairly simple rule, like ~allow en.wikipedia.org~, you can do so through the browser extension. If you want to specify a recurring schedule, a media type, a program, or something else advanced, or if you want to add a [[features][feature]], you will have to follow the console instructions below.
21
+1. Click on the Pluckeye button in the top right of your browser.
22
+2. Specify what you want the rule to do.
23
+ * If you want a simple ~allow~ or ~block~ rule for the whole website (e.g., wikipedia.org), just click the "allow" button or the "block" button.
24
+ * If you want to add a rule for a subdomain (e.g., en.wikipedia.org) or a particular page, click the arrow next to "allow" or "block" and select exactly what you want to be allowed or blocked.
25
+ * If you want to add a temporary rule, click "always" and select how long you want the rule to take effect for. Then use the "allow" or "block" button.
26
+
27
+** Through [[//u.pluckeye.net/][the users site]]
28
+ If you already have an account and a configuration on the users site, and the configuration is assigned to the device you are using:
29
+1. Determine what rule you want to add, using the rule types described below.
30
+2. Go to the page for the configuration.
31
+3. Click the "Edit" tab.
32
+4. Add the rule to the list of rules. You /should not/ type ~pluck +~ or ~pluck -~ before a rule, and for configurations with "allow" or "block" in their type (like allowed urls lists), you should not include "allow" or "block" in the rule, as it is implied. It does not matter where in the list you add it; the list will be automatically sorted alphabetically. The rules in a general configuration appear slightly different than how you type them in a console (e.g., ~action:allow host:wikipedia.org~ instead of ~allow wikipedia.org~), but you can use either form and it will work fine.
33
+5. Click "Save".
34
+
35
+** Through a console
36
+1. Determine what rule you want to add, using the rule types described below.
37
+2. [[how-to-open-a-console-window][Open a console window]]. If this is new to you, reading [[notation][Notation]] may also be helpful.
38
+3. Depending on your version:
39
+ * *v0.99.12+*: To add a rule or a feature, use [[commands#add][the + command]]. To remove a rule or a feature, use [[commands#minus][the - command]].
40
+ * *v0.99.11 or older*: Use the deprecated ~add~ and ~del~ commands, which behave similarly to [[commands#add][the + command]] and [[commands#minus][the - command]].
41
+
42
+* Rule types
43
+** allow
44
+ Console usage: ~pluck <+ / -> allow [context]~
45
+
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
+
48
+*** Examples
49
+#+BEGIN_EXAMPLE
50
+pluck + allow google.com
51
+#+END_EXAMPLE
52
+
53
+#+BEGIN_EXAMPLE
54
+pluck + allow https://www.youtube.com/watch?v=AkoML0_FiV4
55
+#+END_EXAMPLE
56
+
57
+#+BEGIN_EXAMPLE
58
+pluck + allow image/svg
59
+#+END_EXAMPLE
60
+
61
+** block
62
+ Console usage: ~pluck <+ / -> block [context]~
63
+
64
+ Blocks content from a specified website, page, or program, or blocks a specific type of content. If you block an entire website (e.g., ~pluck + block youtube.com~), all resources (images, videos, etc.) from the website will be blocked, even when they are embedded in a page on a different website. For example, if you block youtube.com, you will not be able to watch any YouTube videos, even ones that people have posted on Facebook (/even if/ you have an [[#allow][allow]] rule for Facebook).
65
+
66
+*** v1.0
67
+ 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.
68
+
69
+*** Examples
70
+#+BEGIN_EXAMPLE
71
+pluck + block youtube.com
72
+#+END_EXAMPLE
73
+
74
+#+BEGIN_EXAMPLE
75
+pluck + block https://www.youtube.com/watch?v=8ftDjebw8aA
76
+#+END_EXAMPLE
77
+
78
+#+BEGIN_EXAMPLE
79
+pluck + block image/png
80
+#+END_EXAMPLE
81
+
82
+** noop
83
+ Console usage: ~pluck <+ / -> noop <context>~
84
+
85
+ ~noop~ can be used to override a rule at the same priority level. It can be thought of as "unblock" or "unallow".
86
+
87
+ Added in [[release-notes#v0-99-13-2019-12-14][v0.99.13]].
88
+
89
+*** Examples
90
+ To block wikipedia.org, but keep the default behaviour (load with no images if you have the default configuration) for sg.wikipedia.org:
91
+#+BEGIN_EXAMPLE
92
+pluck + block wikipedia.org
93
+pluck + noop sg.wikipedia.org
94
+#+END_EXAMPLE
95
+
96
+** when
97
+ Console usage: ~pluck <+ / -> when <schedule> <allow / block> <context>~
98
+
99
+ Do something according to a schedule. The users site has a [[https://u.pluckeye.net/hrs3][point-and-click tool you can use to find a schedule]] to describe a specific set of time periods. The schedule format used by scheduled rules is not well documented, but here's how the days of the week are represented:
100
+
101
+- UMTWRFA :: sUn, Mon, Tue, Wed, thuR, Fri, sAt
102
+
103
+*** Examples
104
+ On Mondays, Wednesdays, and Fridays (~MWF~) from midnight to 8 am (~0-8~), block /all/ Internet access.
105
+#+BEGIN_EXAMPLE
106
+pluck + when MWF0-8 block everything
107
+#+END_EXAMPLE
108
+
109
+ Every day from noon to 1 pm (~12-13~) and also from 7 pm to 9 pm (~19-21~), allow ~facebook.com~.
110
+#+BEGIN_EXAMPLE
111
+pluck + when 12-13&19-21 allow facebook.com
112
+#+END_EXAMPLE
113
+
114
+** Legacy
115
+This rule types is oudated, but was used in older versions of Pluckeye.
116
+
117
+*** sometimes
118
+ Replaced by [[#when][when]].
119
+
120
+* Contexts
121
+ A context refers to a website, page, program, etc. Contexts are used inside of rules.
122
+
123
+** everything
124
+ Console usage: ~pluck <+ / -> <allow / block> everything~
125
+
126
+ ~everything~ refers to all websites, pages, programs, etc. ~block everything~ takes precedence over every other rule, so it /will block all/ Internet access. ~allow everything~ will override all rules except ~block everything~, giving full Internet access. ~everything~ is often used with in a [[#when][when]] rule.
127
+
128
+ /See also: [[commands#clear][clear]]/
129
+
130
+*** Examples
131
+ This will give you full internet access, as long as you don't already have ~block everything~ in your configuration:
132
+#+BEGIN_EXAMPLE
133
+pluck + allow everything
134
+#+END_EXAMPLE
135
+
136
+See [[#when][when]] above for an example of blocking everything only at certain times.
137
+
138
+** Legacy
139
+These contexts are outdated, but were used in older versions of Pluckeye.
140
+
141
+*** blackout
142
+ Replaced by [[#everything][block everything]]. Deprecated since [[release-notes#v0-99-11-2019-11-26][v0.99.11]] or earlier.
143
+
144
+*** whiteout
145
+ Replaced by [[#everything][allow everything]]. Deprecated since [[release-notes#v0-99-11-2019-11-26][v0.99.11]] or earlier.
safe.org
... ...
@@ -2,7 +2,7 @@
2 2
title: Safe features | Pluckeye
3 3
---
4 4
5
-This page applies to Pluckeye 1.0 and above.
5
+ The features described in this article were added to Pluckeye in [[release-notes#v1-0-10-2020-09-29][v1.0.10]], so they won't work in earlier versions.
6 6
7 7
* Overview
8 8
... ...
@@ -25,10 +25,10 @@ This page applies to Pluckeye 1.0 and above.
25 25
26 26
These generic options may include technologies that allow third
27 27
parties (such as Google) to observe your browsing. If this concerns
28
- you, see the privacy section below.
28
+ you, see the [[#privacy-and-unsafesites][privacy section]] below.
29 29
30 30
It is worth noting that most "safe" options take precedence over all
31
- Pluckeye's allow rules including =allow everything=.
31
+ Pluckeye's allow rules, /including [[rules#everything][allow everything]]/.
32 32
33 33
* TL;DR
34 34
... ...
@@ -38,8 +38,7 @@ This page applies to Pluckeye 1.0 and above.
38 38
39 39
If the result filters too little of youtube, use =pluck + safer=.
40 40
41
- If you are zealous about privacy read more about =pluck +
42
- unsafesites=.
41
+ If you are zealous about privacy [[#privacy-and-unsafesites][read more about]] =pluck + unsafesites=.
43 42
44 43
* Details
45 44
... ...
@@ -81,7 +80,7 @@ This page applies to Pluckeye 1.0 and above.
81 80
3. Consider for a moment how much you value your privacy, and how
82 81
much you value the filtering that safe browsing can provide. Do
83 82
not succumb to a privacy-is-everything knee-jerk reaction without
84
- giving due consideration to what's /really/ valuable /for you
83
+ giving due consideration to what's /really/ valuable /for your
85 84
life/.
86 85
87 86
Having said that, if you want safe search, but you do not want
supporter-guide.md
... ...
@@ -0,0 +1,36 @@
1
+---
2
+title: Supporter guide | Pluckeye
3
+---
4
+
5
+There are currently two kinds of supporters: [approvers](glossary#approver) and [inspectors](glossary#inspector).
6
+
7
+## Approver guide
8
+As an approver, you have the ability to accept or reject expedite requests made by your approvees. You will see these requests in [your queue](//u.pluckeye.net/queue). When deciding what to accept, use good judgement, but respect the approvee. Most, but not all, expedite requests should be granted. Keep in mind what the user has shared (if anything) in their description about what they want to avoid. Be cautious of overly broad rules. (E.g., `allow youtube.com` would be too broad for many, but perhaps not all, users.)
9
+
10
+An approvee who abuses the approval system should add the [noapproval feature](features#noapproval) to their configuration.
11
+
12
+## Inspector guide
13
+The approver guide above also applies to inspectors.
14
+
15
+There are a few subtleties of the users site of which inspectors should be aware.
16
+
17
+An inspector should know the following [terms](glossary):
18
+
19
+* [configuration](glossary#configuration)
20
+* [device](glossary#device)
21
+
22
+Let's look at each of these in depth.
23
+
24
+### Configuration
25
+A configuration is a set of Pluckeye rules. Configurations are distinct from devices so that multiple devices can share the same configuration.
26
+
27
+Every configuration also has a built-in delay. Some actions, such as uninstalling Pluckeye, can only be performed if the delay is 0. Other actions, such as adding newly allowed sites or disabling features, may be performed subject to the delay.
28
+
29
+Every configuration has a history. The last 30 days of history can be viewed by clicking the "last changed" link near the top of the configuration page. This is how you can see what changes your inspectee has made to their configuration over time.
30
+
31
+### Device
32
+A device represents a physical device such as a desktop computer, a laptop, or a smart phone. One user may have many devices.
33
+
34
+Every device has either 0 or 1 configuration associated with it. If a device has no configuration associated with it, then the owner of the device has not uploaded their configuration for inspection. It's private. If you are an inspector for somebody else, generally the device configuration should not be private. The person using Pluckeye may need to [upload their configuration](synchronizing-configurations#uploading-a-configuration).
35
+
36
+Every device on the users site also has an associated configuration assignment delay. This delay governs how long a Pluckeye user must wait to change **which configuration** is associated with their device. This is **not the same** as the delay that governs how long a change to a configuration is delayed. Generally, the delay for a device can and should be very high (e.g., 2 weeks) because users with inspectors should rarely change which configuration is associated with their device.
synchronizing-configurations.org
... ...
@@ -0,0 +1,54 @@
1
+---
2
+title: Synchronizing configurations | Pluckeye
3
+---
4
+
5
+Synchronizing your configurations using [[//u.pluckeye.net/][the Pluckeye users site]] allows you to:
6
+
7
+1. Use a common configuration on different devices.
8
+2. Make your configuration changes visible to others for accountability.
9
+3. Restore your local configuration from the online backup if your local configuration is lost.
10
+
11
+ On Android, synchronization occurs automatically, so if you're only using Android you can stop reading here. But be aware that *Pluckeye on Android currently only handles general configurations.*.
12
+
13
+ For desktop Pluckeye, synchronization can be initiated in one of two ways:
14
+
15
+1. [[#uploading-a-configuration][Uploading a configuration]].
16
+2. [[#assigning-a-remote-configuration][Assigning a remote configuration to your device]].
17
+
18
+*** Uploading a configuration
19
+
20
+ *Warning*: This won't work correctly on Pluckeye before version 1.0. If you're using Pluckeye 0.99.x, skip down to [[#manually-uploading-a-configuration][manual upload]] below.
21
+
22
+ By default, the desktop version of Pluckeye stores configuration only on your local computer and does not copy it to the users site.
23
+
24
+ If you would like to share the configuration from your local computer with another device, you first need to upload it. To do this [[/how-to-open-a-console-window][open a console]] and in it type:
25
+
26
+~pluck upload~
27
+
28
+ After that, the configuration should automatically synchronize to and from the users site. It can then be shared with another device by assigning the configuration to another device, or by importing it in another configuration.
29
+
30
+*** Manually uploading a configuration
31
+
32
+ Another way to "upload" your configuration is to simply export it to a file, then the copy the contents into a new configuration on u.pluckeye.net, and then assign that configuration to your device. Step by step:
33
+
34
+1. Export your configuration to a file by running =cd Destkop && pluck export >settings.txt= [[/how-to-open-a-console-window][in a console]]. This should create a file named settings.txt on your desktop.
35
+2. Open settings.txt in an editor such as notepad.
36
+3. Copy the contents by hitting Ctrl-A Ctrl-C.
37
+4. [[//u.pluckeye.net/configurations/new?kind=general][Create a new configuration]], with any name you like.
38
+5. Paste the configuration contents (Ctrl-V) into the textarea under the edit tab.
39
+6. Click "Save".
40
+7. [[#assigning-a-remote-configuration][Assign the remote configuration to your device.]]
41
+
42
+*** Assigning a remote configuration
43
+
44
+ You can [[//u.pluckeye.net/configurations/new?kind=general][create a general configuration on the users site]] and [[//u.pluckeye.net/device][assign it to your device]]. Doing so will cause your device to use the newly created configuration rather than the configuration that already exists on the device. Only a *general configuration* may be assigned to a device.
45
+
46
+ If you have a substantial local configuration, you may want to [[#uploading-a-configuration][upload it]] before assigning another configuration to your device.
47
+
48
+*** Synchronizing local configuration with remote
49
+
50
+ After you have assigned a remote configuration (i.e., one on the users site) to your device, you can synchronize your local version with the remote one by running:
51
+
52
+~pluck sync~
53
+
54
+ However, changes made remotely may still take some time to come into effect on your devices. Hence, if you need to make an immediate change that will not be subject to your delay (e.g., adding a =block= rule), you should make the change on the device (i.e., by interacting with the browser extension or by typing =pluck= commands in a [[/how-to-open-a-console-window][console]]) and then use =pluck sync=.
system.org
... ...
@@ -0,0 +1,32 @@
1
+---
2
+title: system | Pluckeye
3
+---
4
+
5
+ The Pluckeye ~system~ feature, when turned on, causes Pluckeye to integrate more deeply with your device, meaning it will control the Internet access of the device rather than just an Internet browser.
6
+ It is turned off when Pluckeye is first installed, but it is expected that most serious users of Pluckeye will turn it on. When ~system~ is off, it is easy to bypass Pluckeye by using a different browser that does not have the Pluckeye browser extension installed, or by removing the extension from your browser.
7
+
8
+* How to turn it on / off
9
+** v1.0+
10
+ In [[how-to-update][Pluckeye v1.0]], you can turn the feature on or off as follows:
11
+1. Click the Pluckeye button in the top right corner of your browser.
12
+2. Click "config" in the menu at the top.
13
+3. Click the button that says "system: off" or "system: on".
14
+4. Read the description.
15
+5. Check or uncheck the "enable" box.
16
+6. Click "Apply".
17
+
18
+** v0.99.12+
19
+ If you are using Pluckeye v0.99.12 or newer, you can turn ~system~ on by [[how-to-open-a-console-window][opening a console]] and running this command:
20
+#+BEGIN_SRC sh
21
+pluck + system
22
+#+END_SRC
23
+ To turn it back off, just run the same command, but replace ~+~ with ~-~.
24
+
25
+** v0.99.11 and older
26
+ See [[#levels][Levels]] below.
27
+
28
+* Why isn't ~system~ on by default?
29
+ The ~system~ feature is initially turned off mainly as a safety measure. By requiring the user to turn it on it manually, the user is then educated on how to do the reverse as well. And some users find Pluckeye to be sufficient help for them, even with ~system~ turned off.
30
+
31
+* Levels
32
+ The ~system~ feature replaced the idea of [[old-and-inaccurate/levels][levels in older versions]] of Pluckeye (v0.99.11 and older). Having Pluckeye installed as a program on your device (not just a browser extension) with ~system~ off is equivalent to level 1, and having ~system~ on is equivalent to level 2.
tips.org
... ...
@@ -42,11 +42,11 @@ title: Tips | Pluckeye
42 42
But if 1 or 2 days isn't enough, then by all means increase it (and
43 43
[[https://contact.pluckeye.net/][let us know]]).
44 44
45
-* Use Chrome, Brave, Vivaldi, or another Chromium-based browser
45
+* Use Chrome, [[https://brave.com/][Brave]], [[https://vivaldi.com/][Vivaldi]], or another Chromium-based browser
46 46
47 47
Pluckeye used to work with Firefox, but support for Firefox is
48 48
lagging. If you love Firefox, you can make it work. Similarly with
49
- [[http://palemoon.org/][Pale Moon]] , Waterfox and some other lesser known browsers.
49
+ [[http://palemoon.org/][Pale Moon]], [[https://www.waterfox.net/][Waterfox]] and some other lesser-known browsers.
50 50
51 51
If you install a Firefox-based browser after installing Pluckeye,
52 52
then you may need to enable the Pluckeye extension manually. In
... ...
@@ -71,7 +71,7 @@ title: Tips | Pluckeye
71 71
72 72
Seriously; do whatever it takes.
73 73
74
-** Option 2, a scheduled rule in Pluckeye.
74
+** Option 2, a scheduled rule in Pluckeye
75 75
76 76
Another options is to schedule a whitelisting for a limited amount
77 77
of time when you know you'll be in a healthy frame of mind. For
... ...
@@ -93,7 +93,7 @@ title: Tips | Pluckeye
93 93
pluck + when 10-12 allow amazon.com
94 94
#+END_SRC
95 95
96
-* Schedule a whiteout once a week.
96
+* Schedule a whiteout once a week
97 97
98 98
If you think you can handle a periodic whiteout, it might alleviate
99 99
some of the pain in using Pluckeye. Depending on your settings,
... ...
@@ -235,7 +235,7 @@ title: Tips | Pluckeye
235 235
search for a program and/or other people who can help you to grow.
236 236
Here is a list of [[https://wiki.pluckeye.net/resources][sites and organizations]] to get you started.
237 237
238
-* Recognize when Pluckeye is not the right tool for you.
238
+* Recognize when Pluckeye is not the right tool for you
239 239
240 240
There are some who instead of installing Pluckeye should be:
241 241
... ...
@@ -247,4 +247,4 @@ title: Tips | Pluckeye
247 247
248 248
* Don't give up
249 249
250
- Long-term usually change takes time. Don't give up.
250
+ Long-term change usually takes time. Don't give up.
users-site/supporter-guide.md.md
... ...
@@ -1,33 +0,0 @@
1
-# Supporter guide | Users site | Pluckeye
2
-
3
-There are currently 2 kinds of supporters: [approvers](glossary#approver) and [inspectors](glossary#inspector).
4
-
5
-## Approver guide
6
-This is a quick introduction to approving expedite requests.
7
-
8
-In short, use good judgement, but respect the approvee. Most, but not all, expedite requests should be granted. An approvee who abuses the approval system should add `noapproval` to their configuration.
9
-
10
-## Inspector guide
11
-This document is intended to orient inspectors to this site, as there are a few subtleties of which inspectors should be aware.
12
-
13
-An inspector should understand the following [terms](glossary):
14
-1. [configuration](glossary#configuration)
15
-1. [device](glossary#device)
16
-
17
-Let's look at each of these in depth.
18
-
19
-### Device
20
-
21
-A device represents a physical device such as a desktop computer, a laptop, or a smart phone. One user may have many devices.
22
-
23
-Every device has either 0 or 1 configuration associated with it. If a device has no configuration associated with it, then the owner of the device has not uploaded their configuration for inspection. It's private. If you are an inspector for somebody else, generally the device configuration should not be private. The person using Pluckeye may need to [upload their configuration](upload-configuration).
24
-
25
-Every device on this site also has an associated configuration assignment delay. This delay governs how long a Pluckeye user must wait to change **which configuration** is associated with their device. This is **not the same** as the delay that governs how long a change is delayed to a configuration. Generally, this delay can and should be very high (e.g., 2 weeks) because users with inspectors should rarely change which configuration is associated with their device.
26
-
27
-### Configuration
28
-
29
-A configuration is a set of Pluckeye rules. Configurations are distinct from devices so that multiple devices can share the same configuration.
30
-
31
-Every configuration also has a built-in delay. Some actions, such as uninstalling Pluckeye, can only be performed if the delay is 0. Other actions, such as adding newly allowed sites or disabling features, may be performed subject to the delay.
32
-
33
-Every configuration has a history. The last 30 days of history can be viewed by clicking the "last changed" link near the top of the configuration page. This is how you can see what changes your inspectee has made to their configuration over time.
writing-a-profile-description.md
... ...
@@ -0,0 +1,21 @@
1
+---
2
+title: Writing a profile description | Pluckeye
3
+---
4
+
5
+The description field of your profile on [the users site](//u.pluckeye.net/) is intended to give you space to describe yourself for supporters that may not know you in real life. It helps them to picture you as a real person, and to have some idea what kind of approvals are safe for you. But of course, this is optional. Use it if it helps. Skip it if it doesn't. Below are some example descriptions.
6
+
7
+## Transparent
8
+
9
+> My name is Dan. I work at a library, and I love it. I frequently use the computer at work during normal business hours, which are 8am-5pm PST. During those times, I am unlikely to want any filtering at all because . . . (and so on).
10
+
11
+## Medium
12
+
13
+> I'm a software developer, and I spend a lot of time on the internet for work. I rarely use multimedia sites such as YouTube, and if I do, it is almost always to watch a specific video of educational nature. I mainly want to avoid porn.
14
+
15
+## Minimal
16
+
17
+> I want to avoid all social media from the hours of 8am to 5pm.
18
+
19
+> I want no images of people on any website, ever.
20
+
21
+> I find gambling sites tempting and problematic. I want to avoid them.