-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathconfiguration.html
More file actions
842 lines (723 loc) · 55.1 KB
/
configuration.html
File metadata and controls
842 lines (723 loc) · 55.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>7. Configuration — Keypirinha</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="8. Theming" href="theming.html" />
<link rel="prev" title="6. Third-Party Packages" href="contributions.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> Keypirinha
<img src="_static/app-128.png" class="logo" alt="Logo"/>
</a>
<div class="version">
2.26
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="download.html">1. Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="update.html">3. Update Procedure</a></li>
<li class="toctree-l1"><a class="reference internal" href="first.html">4. First steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="shipped-packages.html">5. Shipped Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributions.html">6. Third-Party Packages</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">7. Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#introduction">7.1. Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="#first-modification">7.2. First Modification</a></li>
<li class="toctree-l2"><a class="reference internal" href="#modification-at-runtime">7.3. Modification at Runtime</a></li>
<li class="toctree-l2"><a class="reference internal" href="#the-ini-format">7.4. The INI Format</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#example">7.4.1. Example</a></li>
<li class="toctree-l3"><a class="reference internal" href="#comments">7.4.2. Comments</a></li>
<li class="toctree-l3"><a class="reference internal" href="#multiple-line-values">7.4.3. Multiple Line Values</a></li>
<li class="toctree-l3"><a class="reference internal" href="#reusable-values">7.4.4. Reusable Values</a></li>
<li class="toctree-l3"><a class="reference internal" href="#predefined-variables">7.4.5. Predefined variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="#environment-values">7.4.6. Environment Values</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#machine-and-user-specific-settings">7.5. Machine and User Specific Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="theming.html">8. Theming</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard.html">9. Keyboard Shortcuts</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom-catalog.html">10. Customize your Catalog</a></li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">11. Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="packages.html">12. Packages Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">13. Extending Keypirinha (API)</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribute.html">14. Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">15. Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">16. Frequently Asked Questions (FAQ)</a></li>
<li class="toctree-l1"><a class="reference internal" href="credits.html">17. Credits</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Keypirinha</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><span class="section-number">7. </span>Configuration</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="configuration">
<h1><span class="section-number">7. </span>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2><span class="section-number">7.1. </span>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>Keypirinha is file-driven. Its configuration data resides in files, which are
human readable and modifiable.</p>
<p>By design, Keypirinha does not offer any graphical interface to modify its
settings, neither does it alter your configuration files.</p>
<p>While, at first glance, it might seem like backward design choice for
a desktop application, it perfectly makes sense when you realize how powerful
and flexible it can be:</p>
<ul class="simple">
<li><p>variables assignment</p></li>
<li><p>use of system or environment variables anywhere</p></li>
<li><p>machine-specific and/or user-specific configuration</p></li>
</ul>
<p>Nevertheless, Keypirinha offers a convenient way to open and edit its
configuration files at runtime.</p>
<p>Search for the “Keypirinha: Configure …” items from the <a class="reference internal" href="glossary.html#term-LaunchBox"><span class="xref std std-term">LaunchBox</span></a>.</p>
<img alt="The 'Configure' items" class="align-center" src="_images/wndrun-config-search.png" />
<p>Or use the main popup menu by clicking the right mouse button anywhere on the
<a class="reference internal" href="glossary.html#term-LaunchBox"><span class="xref std std-term">LaunchBox</span></a> except the text field.</p>
<img alt="The 'Configure' menu" class="align-center" src="_images/wndrun-config-menu.png" />
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Any change to the configuration files will be detected automatically at
runtime and new/modified settings will immediately be applied.</p>
</div>
</div>
<div class="section" id="first-modification">
<h2><span class="section-number">7.2. </span>First Modification<a class="headerlink" href="#first-modification" title="Permalink to this headline">¶</a></h2>
<p>If you have selected the <code class="docutils literal notranslate"><span class="pre">Configure</span> <span class="pre">Application</span></code> item for the first time, you
should now see two text files opened side by side on your screen.</p>
<p>The one on the <strong>left</strong> is the original configuration file, bundled with the
application. It shows the exhaustive list of the available settings. This file
is <strong>not</strong> meant to be modified. Let’s call it <code class="docutils literal notranslate"><span class="pre">Default</span></code>.</p>
<p>The one on the <strong>right</strong> side should be blank on a fresh install, which means
all the default configuration values defined in the <code class="docutils literal notranslate"><span class="pre">Default</span></code> file are used.
Let’s call this file <code class="docutils literal notranslate"><span class="pre">User</span></code>.</p>
<img alt="The 'Configure' menu" class="align-center" src="_images/config-edit.png" />
<p>Configuration files in Keypirinha are <code class="docutils literal notranslate"><span class="pre">INI</span></code> files. This format has been chosen
because it is easy to read and to edit. But there are some things to keep in
mind when editing a configuration file…</p>
<p>Say you want to modify the <code class="docutils literal notranslate"><span class="pre">max_results</span></code> value for example. In
Keypirinha’s <code class="docutils literal notranslate"><span class="pre">INI</span></code> files, every value belongs to a given <strong>section</strong>. So if
you just add a single line like <code class="docutils literal notranslate"><span class="pre">max_results</span> <span class="pre">=</span> <span class="pre">100</span></code> to the <code class="docutils literal notranslate"><span class="pre">User</span></code> file,
it <strong>will not</strong> have the desired effect. The <code class="docutils literal notranslate"><span class="pre">max_results</span></code> setting is
part of the <code class="docutils literal notranslate"><span class="pre">gui</span></code> section so you must prepend the <code class="docutils literal notranslate"><span class="pre">[gui]</span></code> line.</p>
<p>The default value of <code class="docutils literal notranslate"><span class="pre">max_results</span></code> is <code class="docutils literal notranslate"><span class="pre">100</span></code>, let’s change it to <code class="docutils literal notranslate"><span class="pre">90</span></code>. The
<code class="docutils literal notranslate"><span class="pre">User</span></code> file should now look like this:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[gui]</span>
<span class="na">max_results</span> <span class="o">=</span> <span class="s">90</span>
</pre></div>
</div>
<p>Save the <code class="docutils literal notranslate"><span class="pre">User</span></code> configuration file by pressing <kbd class="kbd docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">S</kbd></kbd> or by clicking
the <span class="menuselection">File ‣ Save</span> menu of the editor. Modifications are now
applied, you can close both editor windows.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">gui</span></code> section was already declared in your configuration file, you
do not need to repeat the <code class="docutils literal notranslate"><span class="pre">[gui]</span></code> line as long as its settings are all
grouped under it. For example:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[gui]</span>
<span class="na">show_on_taskbar</span> <span class="o">=</span> <span class="s">no</span>
<span class="na">max_results</span> <span class="o">=</span> <span class="s">90</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="modification-at-runtime">
<h2><span class="section-number">7.3. </span>Modification at Runtime<a class="headerlink" href="#modification-at-runtime" title="Permalink to this headline">¶</a></h2>
<p>When you save a new version of one or several of your configuration files,
Keypirinha automatically detects the modifications you have made, if any, and
apply them at runtime. The same apply to packages’ configuration.</p>
</div>
<div class="section" id="the-ini-format">
<h2><span class="section-number">7.4. </span>The INI Format<a class="headerlink" href="#the-ini-format" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">INI</span></code> file format is not precisely defined and there are plenty of
variants out there. The format used by Keypirinha is readable by
<a class="reference external" href="https://docs.python.org/3.6/library/configparser.html#module-configparser" title="(in Python v3.6)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> (<code class="docutils literal notranslate"><span class="pre">ExtendedInterpolation</span></code> is used), a <a class="reference external" href="https://python.org">Python</a> standard
module for those who are familiar with it.</p>
<div class="section" id="example">
<span id="ini-example"></span><h3><span class="section-number">7.4.1. </span>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="c1"># This is a comment line so I can write whatever I want</span>
<span class="k">[config]</span>
<span class="c1"># Values defined below belong to the 'config' section</span>
<span class="na">boolean_value</span> <span class="o">=</span> <span class="s">yes</span>
<span class="na">editor</span> <span class="o">=</span> <span class="s">${var:my_editor}</span>
<span class="na">say_hello</span> <span class="o">=</span> <span class="s">${var:hello} World</span>
<span class="na">multiline_setting</span> <span class="o">=</span><span class="s"></span>
<span class="s"> ${say_hello}</span>
<span class="s"> This is a multiple line value.</span>
<span class="s"> You can add as much lines as desired.</span>
<span class="s"> As long as they are indented deeper than the first line of the value.</span>
<span class="k">[var]</span>
<span class="c1"># Reusable values are grouped into the 'var' section</span>
<span class="na">my_editor</span> <span class="o">=</span> <span class="s">D:/Apps/MyEditor/ShinyEditor.exe</span>
<span class="na">hello</span> <span class="o">=</span> <span class="s">Hello</span>
</pre></div>
</div>
</div>
<div class="section" id="comments">
<h3><span class="section-number">7.4.2. </span>Comments<a class="headerlink" href="#comments" title="Permalink to this headline">¶</a></h3>
<p>It is possible to add comments to an <code class="docutils literal notranslate"><span class="pre">INI</span></code> file. Comments are not interpreted
by the application and they are skipped at parsing-time.</p>
<p>To add a comment to your configuration file, start a line with a <code class="docutils literal notranslate"><span class="pre">#</span></code>
character.</p>
</div>
<div class="section" id="multiple-line-values">
<h3><span class="section-number">7.4.3. </span>Multiple Line Values<a class="headerlink" href="#multiple-line-values" title="Permalink to this headline">¶</a></h3>
<p>Keypirinha or its packages may accept multiple line values for some of their
settings (it is always specified). When you write mutiple line values, you must
take care of <strong>indenting</strong> each line correctly to ensure the configuration file
will be interpreted properly by the application.</p>
<p>See the <a class="reference internal" href="#ini-example"><span class="std std-ref">Example</span></a> section above for an exampe.</p>
</div>
<div class="section" id="reusable-values">
<h3><span class="section-number">7.4.4. </span>Reusable Values<a class="headerlink" href="#reusable-values" title="Permalink to this headline">¶</a></h3>
<p>Keypirinha allows you to declare values that can be used elsewhere in <strong>any</strong>
configuration file (application and plugins).</p>
<p>If you wish your reusable value to be usable in any configuration file, you must
declare it in the <code class="docutils literal notranslate"><span class="pre">var</span></code> dedicated section in the main application’s
configuration file <code class="file docutils literal notranslate"><span class="pre">Keypirinha.ini</span></code>. Keypirinha will take care of
replicating the <code class="docutils literal notranslate"><span class="pre">var</span></code> section in every subsequently loaded configuration file.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>While it is possible to have a <code class="docutils literal notranslate"><span class="pre">var</span></code> section in any configuration file, it
is usually preferable to have your reusable values all grouped in the same
file (i.e.: <code class="file docutils literal notranslate"><span class="pre">Keypirinha.ini</span></code>) to avoid mistakes and unexpected
behavior.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">var</span></code> section does not have to be defined at the beginning of the
file.</p>
</div>
<p>See the <a class="reference internal" href="#ini-example"><span class="std std-ref">Example</span></a> section above for an exampe.</p>
</div>
<div class="section" id="predefined-variables">
<h3><span class="section-number">7.4.5. </span>Predefined variables<a class="headerlink" href="#predefined-variables" title="Permalink to this headline">¶</a></h3>
<p>Keypirinha also automatically populates the <code class="docutils literal notranslate"><span class="pre">var</span></code> section with some predefined
values that may come handy.</p>
<p>To use them, use the following syntax in your configuration file: <br />
<code class="docutils literal notranslate"><span class="pre">${var:APP_DIR}</span></code> or <code class="docutils literal notranslate"><span class="pre">${var:KNOWNFOLDER_MUSIC}</span></code>, …</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example of using a variable predefined by Keypirinha</span>
<span class="k">[external]</span>
<span class="na">editor</span> <span class="o">=</span> <span class="s">"${var:APP_DIR}\..\MyEditor\MyEditor.exe"</span>
</pre></div>
</div>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">APP_DRIVE</span></code> <br />
The drive on which the application is installed. <br />
Example:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">C:\</span></code>
<br /> <br /></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">APP_DIR</span></code> <br />
The path to the root/install directory of the application. <br />
Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">C:\Program</span> <span class="pre">Files\Keypirinha</span></code> (installed mode)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">U:\USBApps\Keypirinha</span></code> (portable mode)
<br /> <br /></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">APP_EXE</span></code> <br />
The path to application’s executable <br />
Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">C:\Program</span> <span class="pre">Files\Keypirinha\Keypirinha.exe</span></code> (installed mode)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">U:\USBApps\Keypirinha\Keypirinha.exe</span></code> (portable mode)
<br /> <br /></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">APP_ARCH</span></code> <br />
The architecture of the application. <br />
Possible values:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">x86</span></code> (32-bit)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x64</span></code> (64-bit)
<br /> <br /></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">PROFILE_DIR</span></code> <br />
The <em>Profile</em> directory, parent of the <em>User</em>, <em>InstalledPackages</em> and
<em>Packages</em> directories. <br />
Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">C:\Users\Bob\AppData\Roaming\Keypirinha</span></code> (installed mode)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">U:\USBApps\Keypirinha\portable\Profile</span></code> (portable mode)
<br /> <br /></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">PROFILE_DIR_USER</span></code> <br />
The <em>User</em> directory, where user’s configuration files are stored. <br />
Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">C:\Users\Bob\AppData\Roaming\Keypirinha\User</span></code> (installed mode)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">U:\USBApps\Keypirinha\portable\Profile\User</span></code> (portable mode)
<br /> <br /></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">PROFILE_DIR_INSTALLED_PACKS</span></code> <br />
The <em>InstalledPackages</em> directory, home of the downloaded packages. <br />
Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">C:\Users\Bob\AppData\Roaming\Keypirinha\InstalledPackages</span></code> in installed
mode</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">U:\USBApps\Keypirinha\portable\Profile\InstalledPackages</span></code> in portable
mode
<br /> <br /></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">PROFILE_DIR_LIVE_PACKS</span></code> <br />
The <em>Packages</em> directory, where the live packages (modifiable at runtime) are
stored. <br />
Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">C:\Users\Bob\AppData\Roaming\Keypirinha\Packages</span></code> (installed mode)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">U:\USBApps\Keypirinha\portable\Profile\Packages</span></code> (portable mode)
<br /> <br /></p></li>
</ul>
</li>
<li><p>For convenience, some Windows’
<a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd378457(v=vs.85).aspx">Known Folders</a>
are also predefined. They may come handy to configure some packages.</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example of using a "Known Folder" value</span>
<span class="k">[external]</span>
<span class="na">editor</span> <span class="o">=</span> <span class="s">"${var:KNOWNFOLDER_LOCALAPPDATA}\MyEditor\MyEditor.exe"</span>
</pre></div>
</div>
<table class="docutils align-default">
<colgroup>
<col style="width: 37%" />
<col style="width: 63%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Expands to (example; may differ on your system)</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_ACCOUNTPICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\Microsoft\Windows\AccountPictures</span></code> (Win8+)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_CAMERAROLL</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Pictures\Camera</span> <span class="pre">Roll</span></code> (Win8.1+)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_COMMONSTARTMENU</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ALLUSERSPROFILE%\Microsoft\Windows\Start</span> <span class="pre">Menu</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_COMMONSTARTUP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ALLUSERSPROFILE%\Microsoft\Windows\Start</span> <span class="pre">Menu\Programs\StartUp</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_CONTACTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Contacts</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_DESKTOP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Desktop</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_DOCUMENTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Documents</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_DOWNLOADS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Downloads</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_FAVORITES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Favorites</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_FONTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%windir%\Fonts</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_LINKS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Links</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_LOCALAPPDATA</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%LOCALAPPDATA%</span></code> (<code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\AppData\Local</span></code>)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_LOCALAPPDATALOW</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\AppData\LocalLow</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_MUSIC</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Music</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Pictures</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PLAYLISTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Music\Playlists</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROFILE</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%</span></code> (<code class="docutils literal notranslate"><span class="pre">%SystemDrive%\Users\%USERNAME%</span></code>)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROGRAMFILES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ProgramFiles%</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROGRAMFILESX64</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ProgramFiles%</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROGRAMFILESX86</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ProgramFiles(x86)%</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROGRAMFILESCOMMON</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ProgramFiles%\Common</span> <span class="pre">Files</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROGRAMFILESCOMMONX64</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ProgramFiles%\Common</span> <span class="pre">Files</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROGRAMFILESCOMMONX86</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%ProgramFiles(x86)%\Common</span> <span class="pre">Files</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PROGRAMS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\Microsoft\Windows\Start</span> <span class="pre">Menu\Programs</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PUBLIC</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%PUBLIC%</span></code> (<code class="docutils literal notranslate"><span class="pre">%SystemDrive%\Users\Public</span></code>)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PUBLICDESKTOP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%PUBLIC%\Desktop</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PUBLICDOCUMENTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%PUBLIC%\Documents</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PUBLICDOWNLOADS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%PUBLIC%\Downloads</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PUBLICMUSIC</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%PUBLIC%\Music</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PUBLICPICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%PUBLIC%\Pictures</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_PUBLICVIDEOS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%PUBLIC%\Videos</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_ROAMINGAPPDATA</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%</span></code> (<code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\AppData\Roaming</span></code>)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SCREENSHOTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Pictures\Screenshots</span></code> (Win8+)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SENDTO</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\Microsoft\Windows\SendTo</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SKYDRIVE</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\OneDrive</span></code> (Win8.1+)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SKYDRIVECAMERAROLL</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\OneDrive\Pictures\Camera</span> <span class="pre">Roll</span></code> (Win8.1+)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SKYDRIVEDOCUMENTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\OneDrive\Documents</span></code> (Win8.1+)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SKYDRIVEPICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\OneDrive\Pictures</span></code> (Win8.1+)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_STARTMENU</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\Microsoft\Windows\Start</span> <span class="pre">Menu</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_STARTUP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\Microsoft\Windows\Start</span> <span class="pre">Menu\Programs\StartUp</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SYSTEM</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%windir%\system32</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_SYSTEMX86</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%windir%\system32</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_USERPROFILES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%SystemDrive%\Users</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_USERPROGRAMFILES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%LOCALAPPDATA%\Programs</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_USERPROGRAMFILESCOMMON</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%LOCALAPPDATA%\Programs\Common</span></code> (Win7+)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_VIDEOS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\Videos</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER_WINDOWS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%windir%</span></code></p></td>
</tr>
</tbody>
</table>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Expands to</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_ACCOUNTPICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{008ca0b1-55b4-4c56-b8a8-4de4b299d3be}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_CAMERAROLL</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{ab5fb87b-7ce2-4f83-915d-550846c9537b}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_COMMONSTARTMENU</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{a4115719-d62e-491d-aa7c-e74b8be3b067}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_COMMONSTARTUP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{82a5ea35-d9cd-47c5-9629-e15d2f714e6e}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_CONTACTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{56784854-c6cb-462b-8169-88e350acb882}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_DESKTOP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{b4bfcc3a-db2c-424c-b029-7fe99a87c641}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_DOCUMENTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{fdd39ad0-238f-46af-adb4-6c85480369c7}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_DOWNLOADS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{374de290-123f-4565-9164-39c4925e467b}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_FAVORITES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{1777f761-68ad-4d8a-87bd-30b759fa33dd}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_FONTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{fd228cb7-ae11-4ae3-864c-16f3910ab8fe}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_LINKS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{bfb9d5e0-c6a9-404c-b2b2-ae6db6af4968}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_LOCALAPPDATA</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{f1b32785-6fba-4fcf-9d55-7b8e7f157091}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_LOCALAPPDATALOW</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{a520a1a4-1780-4ff6-bd18-167343c5af16}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_MUSIC</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{4bd8d571-6d19-48d3-be97-422220080e43}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{33e28130-4e1e-4676-835a-98395c3bc3bb}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PLAYLISTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{de92c1c7-837f-4f69-a3bb-86e631204a23}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROFILE</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{5e6c858f-0e22-4760-9afe-ea3317b67173}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROGRAMFILES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{905e63b6-c1bf-494e-b29c-65b732d3d21a}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROGRAMFILESX64</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{6d809377-6af0-444b-8957-a3773f02200e}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROGRAMFILESX86</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{7c5a40ef-a0fb-4bfc-874a-c0f2e0b9fa8e}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROGRAMFILESCOMMON</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{f7f1ed05-9f6d-47a2-aaae-29d317c6f066}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROGRAMFILESCOMMONX64</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{6365d5a7-0f0d-45e5-87f6-0da56b6a4f7d}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROGRAMFILESCOMMONX86</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{de974d24-d9c6-4d3e-bf91-f4455120b917}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PROGRAMS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{a77f5d77-2e2b-44c3-a6a2-aba601054a51}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PUBLIC</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{dfdf76a2-c82a-4d63-906a-5644ac457385}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PUBLICDESKTOP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{c4aa340d-f20f-4863-afef-f87ef2e6ba25}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PUBLICDOCUMENTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{ed4824af-dce4-45a8-81e2-fc7965083634}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PUBLICDOWNLOADS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{3d644c9b-1fb8-4f30-9b45-f670235f79c0}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PUBLICMUSIC</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{3214fab5-9757-4298-bb61-92a9deaa44ff}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PUBLICPICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{b6ebfb86-6907-413c-9af7-4fc2abf07cc5}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_PUBLICVIDEOS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{2400183a-6185-49fb-a2d8-4a392a602ba3}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_ROAMINGAPPDATA</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{3eb685db-65f9-4cf6-a03a-e3ef65729f3d}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SCREENSHOTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{b7bede81-df94-4682-a7d8-57a52620b86f}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SENDTO</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{8983036c-27c0-404b-8f08-102d10dcfd74}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SKYDRIVE</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{a52bba46-e9e1-435f-b3d9-28daa648c0f6}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SKYDRIVECAMERAROLL</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{767e6811-49cb-4273-87c2-20f355e1085b}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SKYDRIVEDOCUMENTS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{24d89e24-2f19-4534-9dde-6a6671fbb8fe}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SKYDRIVEPICTURES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{339719b5-8c47-4894-94c2-d8f77add44a6}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_STARTMENU</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{625b53c3-ab48-4ec1-ba1f-a1ef4146fc19}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_STARTUP</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{b97d20bb-f46a-4c97-ba10-5e3608430854}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SYSTEM</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{1ac14e77-02e7-4e5d-b744-2eb1ae5198b7}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_SYSTEMX86</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{d65231b0-b2f1-4857-a4ce-a8e7c6ea7d27}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_USERPROFILES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{0762d272-c50a-4bb0-a382-697dcd729b80}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_USERPROGRAMFILES</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{5cd7aee2-2219-4a67-b85d-6c9ce15660cb}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_USERPROGRAMFILESCOMMON</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{bcbd3057-ca5c-4622-b42d-bc56db0ae516}</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_VIDEOS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{18989b1d-99b5-455b-841c-ab7c74e4ddfc}</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KNOWNFOLDERGUID_WINDOWS</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">{f38bf404-1d43-42f2-9305-67de0b28fc23}</span></code></p></td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<div class="section" id="environment-values">
<h3><span class="section-number">7.4.6. </span>Environment Values<a class="headerlink" href="#environment-values" title="Permalink to this headline">¶</a></h3>
<p>For convenience, Keypirinha automatically defines a section named <code class="docutils literal notranslate"><span class="pre">env</span></code>,
populated with all the environment variables that could be found at the moment
the configuration file is read.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">env</span></code> section is defined (overwritten) in <strong>every</strong> loaded configuration
file.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>When possible, it is good practice and recommended to use a <code class="docutils literal notranslate"><span class="pre">KNOWNFOLDER</span></code>
predefined variable instead of environment values. This is especially true
if you run Keypirinha on a USB key across multiple machines.</p>
</div>
</div>
</div>
<div class="section" id="machine-and-user-specific-settings">
<h2><span class="section-number">7.5. </span>Machine and User Specific Settings<a class="headerlink" href="#machine-and-user-specific-settings" title="Permalink to this headline">¶</a></h2>
<p>It is possible to have settings that will be applied only when Keypirinha runs on
a specific <strong>machine</strong> and/or under a specific <strong>user</strong> session.</p>
<p>To do that, the configuration file must be named according to a predefined
pattern.</p>
<p>For example, <code class="file docutils literal notranslate"><span class="pre">Keypirinha.ini</span></code> which is application’s main configuration
file. <code class="docutils literal notranslate"><span class="pre">Keypirinha</span></code> being the <em>name</em> part of the file. Keypirinha will
automatically scan for these files each time it has to load its configuration
files, <strong>in order</strong> of precedence, which means a value redefined in a file
<strong>overrides</strong> the previous one(s):</p>
<ul class="simple">
<li><p><code class="file docutils literal notranslate"><span class="pre">Keypirinha.ini</span></code>: the main file</p></li>
<li><p><code class="file docutils literal notranslate"><span class="pre">Keypirinha.@MACHINE.ini</span></code>: machine-specific configuration (any user).
Notice the <code class="docutils literal notranslate"><span class="pre">@</span></code> prefix.</p></li>
<li><p><code class="file docutils literal notranslate"><span class="pre">Keypirinha.USER.ini</span></code>: user-specific configuration (any machine)</p></li>
<li><p><code class="file docutils literal notranslate"><span class="pre">Keypirinha.USER@MACHINE.ini</span></code>: configuration specific to a user on a
specific machine</p></li>
</ul>
<p>Where <code class="docutils literal notranslate"><span class="pre">MACHINE</span></code> is the <em>NetBIOS</em> name of your computer (enter the <code class="docutils literal notranslate"><span class="pre">echo</span>
<span class="pre">%COMPUTERNAME%</span></code> command in a system console to get it) and <code class="docutils literal notranslate"><span class="pre">USER</span></code> is the name
of the currently logged user (<code class="docutils literal notranslate"><span class="pre">echo</span> <span class="pre">%USERNAME%</span></code>).</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>This also works with the packages configuration files located in your <em>User</em>
directory.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="theming.html" class="btn btn-neutral float-right" title="8. Theming" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="contributions.html" class="btn btn-neutral float-left" title="6. Third-Party Packages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2013-2018, Jean-Charles Lefebvre
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-74522446-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>