-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathupdate.html
319 lines (202 loc) · 13.5 KB
/
update.html
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
<!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>3. Update Procedure — 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="4. First steps" href="first.html" />
<link rel="prev" title="2. Installation" href="install.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 current"><a class="current reference internal" href="#">3. Update Procedure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#update-in-installed-mode">3.1. Update in Installed Mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="#update-in-portable-mode">3.2. Update in Portable Mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="#overridden-shipped-packages">3.3. Overridden Shipped Packages</a></li>
</ul>
</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"><a class="reference internal" href="configuration.html">7. Configuration</a></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">3. </span>Update Procedure</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="update-procedure">
<h1><span class="section-number">3. </span>Update Procedure<a class="headerlink" href="#update-procedure" title="Permalink to this headline">¶</a></h1>
<p>If Keypirinha is not installed on your machine yet. You should head over to the
<a class="reference internal" href="install.html"><span class="doc">Installation</span></a> chapter instead.</p>
<p>Keypirinha does not come with an installer yet so the update procedure must be
done manually.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Keypirinha must not be running during the update procedure:</p>
<ul class="simple">
<li><p>Invoke the <a class="reference internal" href="glossary.html#term-LaunchBox"><span class="xref std std-term">LaunchBox</span></a> and search-then-execute the
<code class="docutils literal notranslate"><span class="pre">Keypirinha:</span> <span class="pre">Exit</span></code> item.</p></li>
<li><p><strong>OR</strong> click <code class="docutils literal notranslate"><span class="pre">Exit</span></code> from Keypirinha’s menu (right-click on Keypirinha’s
system tray <code class="docutils literal notranslate"><span class="pre">k</span></code> icon).</p></li>
</ul>
</div>
<p>Once you have ensured Keypirinha is not running, the procedure depends on whether
you chose the <a class="reference internal" href="install.html#install-installed"><span class="std std-ref">Installed Mode</span></a> or the <a class="reference internal" href="install.html#install-portable"><span class="std std-ref">Portable Mode</span></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>To check which mode Keypirinha is running in, open its install directory and
check if the <code class="file docutils literal notranslate"><span class="pre">portable</span></code> directory or the <code class="file docutils literal notranslate"><span class="pre">portable.ini</span></code> file
exists. If it does, you are in <a class="reference internal" href="install.html#install-portable"><span class="std std-ref">Portable Mode</span></a>.</p>
</div>
<div class="section" id="update-in-installed-mode">
<h2><span class="section-number">3.1. </span>Update in Installed Mode<a class="headerlink" href="#update-in-installed-mode" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Open Keypirinha’s install directory <br />
<code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha</span></code> for example <br />
Ensure there is <strong>no</strong> <code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha\portable</span></code> directory</p></li>
<li><p>Delete it <br />
It is safe to do so. In this mode, your configuration files are stored in your
Home folder (i.e. under <code class="file docutils literal notranslate"><span class="pre">%APPDATA%\Keypirinha</span></code>)</p></li>
<li><p>Open Keypirinha’s distribution archive <br />
Its name should be something like <code class="file docutils literal notranslate"><span class="pre">keypirinha-x64-portable.7z</span></code></p></li>
<li><p>Extract its content to <code class="file docutils literal notranslate"><span class="pre">U:\</span></code> <br />
You should now have a <code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha</span></code> directory</p></li>
<li><p>Delete the <code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha\portable</span></code> directory <br />
So Keypirinha knows it must run in Installed Mode</p></li>
<li><p>You’re done <br />
You may now execute the <code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha\keypirinha.exe</span></code> file</p></li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Be sure to read the section below about <a class="reference internal" href="#update-overpacks"><span class="std std-ref">Overridden Shipped Packages</span></a>.</p>
</div>
</div>
<div class="section" id="update-in-portable-mode">
<h2><span class="section-number">3.2. </span>Update in Portable Mode<a class="headerlink" href="#update-in-portable-mode" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Open Keypirinha’s install directory <br />
<code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha</span></code> for example <br />
Ensure there <strong>is</strong> a <code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha\portable</span></code> directory</p></li>
<li><p>Delete everything in <code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha</span></code> <strong>except</strong>
<code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha\portable</span></code> (this is where your configuration files are
located)</p></li>
<li><p>Open Keypirinha’s distribution archive <br />
Its name should be something like <code class="file docutils literal notranslate"><span class="pre">keypirinha-x64-portable.7z</span></code></p></li>
<li><p>Extract its content to <code class="file docutils literal notranslate"><span class="pre">U:\</span></code> <br />
It is OK to overwrite the dummy file <code class="file docutils literal notranslate"><span class="pre">portable\KEEPME</span></code></p></li>
<li><p>You’re done <br />
You may now execute the <code class="file docutils literal notranslate"><span class="pre">U:\Keypirinha\keypirinha.exe</span></code> file</p></li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Be sure to read the section below about <a class="reference internal" href="#update-overpacks"><span class="std std-ref">Overridden Shipped Packages</span></a>.</p>
</div>
</div>
<div class="section" id="overridden-shipped-packages">
<span id="update-overpacks"></span><h2><span class="section-number">3.3. </span>Overridden Shipped Packages<a class="headerlink" href="#overridden-shipped-packages" title="Permalink to this headline">¶</a></h2>
<p>If you have modified some official package, you may want to ensure their code,
their resources <strong>and</strong> the nomenclature of their default configuration files
hasn’t changed!</p>
<p>If you run into trouble with an official package, try first to move away its
loose folder to check if your issue is reproducible.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="first.html" class="btn btn-neutral float-right" title="4. First steps" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="install.html" class="btn btn-neutral float-left" title="2. Installation" 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>