unburden-home-dir-doc 0.4.1 / usr / share / doc / unburden-home-dir / html / index.html

This file is indexed.

/usr/share/doc/unburden-home-dir/html/index.html is in unburden-home-dir-doc 0.4.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <meta name="author" content="Axel Beckert">
  
  <title>Unburden Your Home Directory</title>
  

  <link rel="shortcut icon" href="./img/favicon.ico">

  

  <link rel="stylesheet" href="./css/theme.css" type="text/css" />
  <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />

  
  <script>
    // Current page data
    var mkdocs_page_name = "None";
    var mkdocs_page_input_path = "index.md";
    var mkdocs_page_url = "/index.html";
  </script>
  

  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href="index.html" class="icon icon-home"> Unburden Your Home Directory</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        <ul class="current">
          
            <li>
    <li class="toctree-l1 current">
        <a class="current" href="index.html">Project Home</a>
        
            <ul>
            
                <li class="toctree-l3"><a href="#unburden-your-home-directory">Unburden Your Home Directory</a></li>
                
                    <li><a class="toctree-l4" href="#documentation">Documentation</a></li>
                
                    <li><a class="toctree-l4" href="#talks-about-unburden-your-home-directory">Talks about Unburden Your Home Directory</a></li>
                
            
            </ul>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="installation/index.html">Installation and Dependencies</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="howto/index.html">Getting Started</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="configuration/index.html">Configuration</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="troubleshooting/index.html">Troubleshooting</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="source-code/index.html">Source Code</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="license/index.html">License, Copyright and Author</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="contact/index.html">Contact and Community</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="todo/index.html">Plans, Known Issues, TODO</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="bugs/index.html">Bugs</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="qa/index.html">Quality Assurance</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="see-also/index.html">See Also</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="unburden-home-dir.1/index.html">Appendix: Manual page unburden-home-dir(1)</a>
        
    </li>
<li>
          
            <li>
    <li class="toctree-l1 ">
        <a class="" href="pgp/index.html">Appendix: Retriving PGP Keys Used In The Project</a>
        
    </li>
<li>
          
        </ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">Unburden Your Home Directory</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">Docs</a> &raquo;</li>
    
      
    
    <li>Project Home</li>
    <li class="wy-breadcrumbs-aside">
      
        
          <a href="https://github.com/xtaran/unburden-home-dir" class="icon icon-github"> Edit on GitHub</a>
        
      
    </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <h1 id="unburden-your-home-directory">Unburden Your Home Directory</h1>
<p><code>unburden-home-dir</code> allows users to move cache files from browsers,
etc. off their home directory, i.e. on a local harddisk or tmpfs and
replace them with a symbolic link to the new location (e.g. on <code>/tmp/</code>
or <code>/scratch/</code>) upon login. Optionally the contents of the directories
and files can be removed instead of moved.</p>
<p>This is helpful at least in the following cases:</p>
<ul>
<li>
<p>The idea-giving case are big workstation setups where <code>$HOME</code> is on
  NFS and all those caches put an unnecessary burden (hence the name)
  on the file server since caching over NFS doesn&rsquo;t have the best
  performance and may clog the NFS server, too.</p>
</li>
<li>
<p>A similar case, but with different purpose is reducing I/O on mobile
  devices like laptops or netbooks to extend the battery life or
  reduce the wearing down of CF or SD cards, e.g. in single board
  computers like the <a href="https://www.raspberrypi.org/">Raspberry Pi</a> or
  <a href="http://www.pcengines.ch/alix.htm">ALIX</a> or
  <a href="http://www.pcengines.ch/apu.htm">APU</a> boards: Moving browser caches
  etc. off the real disk into a tmpfs filesystem reduces the amount of
  disk I/O which reduces the power consumption of the disk.</p>
</li>
<li>
<p>Another type of use case for unburden-home-dir is to reduce disk
  space usage, e.g. on devices with small disk space but a lot of RAM
  as seen often on boxes with flash disks or early netbooks, e.g. the
  first EeePC with 4GB disk space and 2GB RAM. In this case you want
  to move off as many cache files, etc. as possible to some tmpfs
  filesystem, e.g. <code>/tmp/</code>.</p>
</li>
<li>
<p>It may also help to reduce the amount of needed backup disk space by
  keeping those files in places where they don&rsquo;t get backed up. In
  that case it&rsquo;s an alternative to keeping the blacklist in your
  backup software up-to-date.</p>
</li>
<li>
<p>Another pragmatic use case may be to stay — as an user — within a
  given disk quota. :-)</p>
</li>
</ul>
<p>This project initially started as an <code>Xsession</code> hook. It now consists
of a perl script which optionally can also be called from a provided
<code>Xsession</code> hook.</p>
<p>While the default configuration includes no logout hook as Debian&rsquo;s
Xsession script, you can run <code>unburden-home-dir -u</code> to reverse the
effect of <code>unburden-home-dir</code> and to move all (moved) directories back
to your home directory.</p>
<p>Nevertheless <code>unburden-home-dir</code> was written with non-valuable data
(cache files, pid files, thumbnails, temporary data, etc.) in mind and
not for preservation of the handled data. So it is likely less
suitable for cases where the handled data should be preserved on
logout or shutdown.</p>
<p>See <a href="https://readme.phys.ethz.ch/linux/application_cache_files/" title="General thoughts about application cache files in home directories">this wiki page about application cache files</a> for the
detailed reasoning behind this project.</p>
<h2 id="documentation">Documentation</h2>
<ul>
<li><a href="./installation">Installation and Dependencies</a></li>
<li><a href="./howto">Getting Started</a></li>
<li><a href="./configuration">Configuration</a></li>
<li><a href="./troubleshooting">Troubleshooting</a></li>
<li><a href="./source-code">Source Code</a></li>
<li><a href="./license">License, Copyright and Author</a></li>
<li><a href="./contact">Contact and Community</a></li>
<li><a href="./todo">Plans, Known Issues, TODO</a></li>
<li><a href="./bugs">Bugs</a></li>
<li><a href="./qa">Quality Assurance</a></li>
<li><a href="./see-also">See Also</a></li>
<li><a href="./unburden-home-dir.1">Manual page unburden-home-dir(1)</a></li>
</ul>
<h2 id="talks-about-unburden-your-home-directory">Talks about Unburden Your Home Directory</h2>
<ul>
<li><a href="https://noone.org/talks/unburden/">Talks given about Unburden Your Home Directory in German</a>
  (external)</li>
<li><a href="https://gitpitch.com/xtaran/unburden-home-dir">GitPitch Slides about Unburden Your Home Directory</a></li>
</ul>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="installation/index.html" class="btn btn-neutral float-right" title="Installation and Dependencies">Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>

  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
	  
        </div>
      </div>

    </section>

  </div>

<div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
          <a href="https://github.com/xtaran/unburden-home-dir" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
      
      
      
        <span style="margin-left: 15px"><a href="installation/index.html" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>

</body>
</html>

<!--
MkDocs version : 0.15.3
Build Date UTC : 2017-11-05 23:30:38
-->

APT Browse - Built by Thomas Orozco.