File: File.html

package info (click to toggle)
libtemplate-perl 2.24-1
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 8,660 kB
  • sloc: perl: 14,518; makefile: 15; sh: 5
file content (512 lines) | stat: -rwxr-xr-x 30,824 bytes parent folder | download | duplicates (2)
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


<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html>
  <head>
    <title>Template::Plugin::File</title>
    <link rel="stylesheet" type="text/css" href="../../../css/blue.css" title="Clear Blue">
    <link rel="alternate stylesheet" type="text/css" href="../../../css/orange.css" title="Clear Orange">
    <link rel="alternate stylesheet" type="text/css" href="../../../css/green.css" title="Clear Green">
    <link rel="alternate stylesheet" type="text/css" href="../../../css/purple.css" title="Clear Purple">
    <link rel="alternate stylesheet" type="text/css" href="../../../css/grey.css" title="Clear Grey">
    <link rel="alternate stylesheet" type="text/css" href="../../../css/print.css" title="Print">
    <!--[if IE 6]>
    <link rel="stylesheet" type="text/css" href="../../../css/ie6.css" />
    <![endif]-->
    <!--[if IE 7]>
    <link rel="stylesheet" type="text/css" href="../../../css/ie7.css" />
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="../../../css/print.css" media="print">
    <script type="text/javascript" src="../../../js/tt2.js"></script>
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
    <meta name="author" content="Andy Wardley">
  </head>
  <body id="body"> 
    <div id="layout">
        <div id="header">
          <a href="../../../index.html" id="logo" alt="" title="Click for the Home Page"><span class="alt">TT2 Home Page</span></a>
          <ul id="trail">
            <li><a href="../../../modules/index.html">Modules</a></li>
            <li><a href="../../../modules/Template/index.html">Template::*</a></li>
            <li><a href="../../../modules/Template/Plugin/index.html">Plugin::*</a></li>
            <li class="last"><a href="../../../modules/Template/Plugin/File.html">File.pm</a></li>
          </ul>
          <div class="controls">
            <a href="#" class="menu show" onclick="widescreen_off(); return false" title="Show Menu">
              <span class="about">Click to view the menu.  It's very nice.</span>
            </a>
            <a href="#" class="menu hide" onclick="widescreen_on();  return false" title="Hide Menu">
              <span class="about">Click to hide the menu and go all widescreen!</span>
            </a>
          
          <div class="pager">
            <a href="../../../modules/Template/Plugin/Dumper.html" title="Template::Plugin::Dumper" class="go back">Back<span class="about"><h4>Template::Plugin::Dumper</h4>Plugin interface to Data::Dumper</span></a>
            <a href="../../../modules/Template/Plugin/index.html" title="Template::Plugin::* Modules" class="go up">Up<span class="about"><h4>Template::Plugin::* Modules</h4></span></a>
            <a href="../../../modules/Template/Plugin/Filter.html" title="Template::Plugin::Filter" class="go next">Next<span class="about"><h4>Template::Plugin::Filter</h4>Base class for plugin filters</span></a>
          </div>
          </div>
          <h1 class="headline">Template::Plugin::File</h1>
          <h2 class="subhead">Plugin providing information about files</h1>
        
        </div>
        
        <div id="page">
          <div id="sidebar">
            <a href="../../../index.html" id="logo"></a>
            <div id="menu">
              <ul class="menu">
                <li class="l0 first"><a href="../../../manual/index.html">Manual</a></li>
                <li class="l0"><a href="../../../modules/index.html" class="warm">Modules</a></li>
                <li class="l1"><a href="../../../modules/Template.html">Template.pm</a></li>
                <li class="l1"><a href="../../../modules/Template/index.html" class="warm">Template::*</a></li>
                <li class="l2"><a href="../../../modules/Template/Base.html">Base.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Config.html">Config.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Constants.html">Constants.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Context.html">Context.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Directive.html">Directive.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Document.html">Document.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Exception.html">Exception.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Filters.html">Filters.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Grammar.html">Grammar.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Iterator.html">Iterator.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Namespace/index.html">Namespace::*</a></li>
                <li class="l2"><a href="../../../modules/Template/Parser.html">Parser.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Plugin.html">Plugin.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Plugin/index.html" class="warm">Plugin::*</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Assert.html">Assert.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/CGI.html">CGI.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Datafile.html">Datafile.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Date.html">Date.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Directory.html">Directory.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Dumper.html">Dumper.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/File.html" class="warm">File.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Filter.html">Filter.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Format.html">Format.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/HTML.html">HTML.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Image.html">Image.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Iterator.html">Iterator.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Math.html">Math.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Pod.html">Pod.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Procedural.html">Procedural.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Scalar.html">Scalar.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/String.html">String.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Table.html">Table.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/URL.html">URL.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/View.html">View.pm</a></li>
                <li class="l3"><a href="../../../modules/Template/Plugin/Wrap.html">Wrap.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Plugins.html">Plugins.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Provider.html">Provider.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Service.html">Service.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Stash.html">Stash.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/Stash/index.html">Stash::*</a></li>
                <li class="l2"><a href="../../../modules/Template/Test.html">Test.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/VMethods.html">VMethods.pm</a></li>
                <li class="l2"><a href="../../../modules/Template/View.html">View.pm</a></li>
                <li class="l0"><a href="../../../tools/index.html">Tools</a></li>
                <li class="l0"><a href="../../../tutorial/index.html">Tutorial</a></li>
                <li class="l0 last"><a href="../../../faq/index.html">FAQ</a></li>
              </ul>
              <div class="foot"></div>
            </div>
          </div>
          <div id="content">
          <div class="section">
            <div class="head">
              <h1 id="contents" onclick="switch_section(this)" title="Click title to show/hide section content.">Contents</h1>
              <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
            </div>
            <div class="body">
              <ul class="toc">
                  <li class=""><a href="#SYNOPSIS">SYNOPSIS</a></li>
                  <li class=""><a href="#DESCRIPTION">DESCRIPTION</a></li>
                  <li class=""><a href="#METHODS">METHODS</a></li>
                  <li class="sub"><a href="#section_path">path</a></li>
                  <li class="sub"><a href="#section_name">name</a></li>
                  <li class="sub"><a href="#section_dir">dir</a></li>
                  <li class="sub"><a href="#section_ext">ext</a></li>
                  <li class="sub"><a href="#section_home">home</a></li>
                  <li class="sub"><a href="#section_root">root</a></li>
                  <li class="sub"><a href="#section_abs">abs</a></li>
                  <li class="sub"><a href="#method_rel">rel(path)</a></li>
                  <li class=""><a href="#EXAMPLES">EXAMPLES</a></li>
                  <li class=""><a href="#AUTHORS">AUTHORS</a></li>
                  <li class=""><a href="#COPYRIGHT">COPYRIGHT</a></li>
                  <li class=""><a href="#SEE_ALSO">SEE ALSO</a></li>
              
              </ul>
            </div>
          </div>
          
                <div class="pod">
            <div class="section">
              <div class="head">
                <h1 id="SYNOPSIS" onclick="switch_section(this)" title="Click title to show/hide section content.">SYNOPSIS</h1>
                <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
              </div>
              <div class="body">
                <pre><span class="tt">[% USE File(filepath) %]</span>
<span class="tt">[% File.path %]</span>         # full path
<span class="tt">[% File.name %]</span>         # filename
<span class="tt">[% File.dir %]</span>          # directory</pre>
              </div>
            </div>
            <div class="section">
              <div class="head">
                <h1 id="DESCRIPTION" onclick="switch_section(this)" title="Click title to show/hide section content.">DESCRIPTION</h1>
                <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
              </div>
              <div class="body">
                <p>
                      This plugin provides an abstraction of a file. It can be used to fetch
                      details about files from the file system, or to represent abstract files
                      (e.g. when creating an index page) that may or may not exist on a file
                      system.
                    </p>
                    <p>
                      A file name or path should be specified as a constructor argument. e.g.
                    </p>
                    <pre><span class="tt">[% USE File('foo.html') %]</span>
<span class="tt">[% USE File('foo/bar/baz.html') %]</span>
<span class="tt">[% USE File('/foo/bar/baz.html') %]</span></pre>
                    <p>
                      The file should exist on the current file system (unless
                      <code>nostat</code> option set, see below) as an absolute file when
                      specified with as leading '<code>/</code>' as per
                      '<code>/foo/bar/baz.html</code>', or otherwise as one relative to the
                      current working directory. The constructor performs a <code>stat()</code>
                      on the file and makes the 13 elements returned available as the plugin
                      items:
                    </p>
                    <pre>dev ino mode nlink uid gid rdev size 
atime mtime ctime blksize blocks</pre>
                    <p>
                      e.g.
                    </p>
                    <pre><span class="tt">[% USE File('/foo/bar/baz.html') %]</span>

<span class="tt">[% File.mtime %]</span>
<span class="tt">[% File.mode %]</span>
...</pre>
                    <p>
                      In addition, the <code>user</code> and <code>group</code> items are set
                      to contain the user and group names as returned by calls to
                      <code>getpwuid()</code> and <code>getgrgid()</code> for the file
                      <code>uid</code> and <code>gid</code> elements, respectively. On Win32
                      platforms on which <code>getpwuid()</code> and <code>getgrid()</code> are
                      not available, these values are undefined.
                    </p>
                    <pre><span class="tt">[% USE File('/tmp/foo.html') %]</span>
<span class="tt">[% File.uid %]</span>      # e.g. 500
<span class="tt">[% File.user %]</span>     # e.g. abw</pre>
                    <p>
                      This user/group lookup can be disabled by setting the <code>noid</code>
                      option.
                    </p>
                    <pre><span class="tt">[% USE File('/tmp/foo.html', noid=1) %]</span>
<span class="tt">[% File.uid %]</span>      # e.g. 500
<span class="tt">[% File.user %]</span>     # nothing</pre>
                    <p>
                      The <code>isdir</code> flag will be set if the file is a directory.
                    </p>
                    <pre><span class="tt">[% USE File('/tmp') %]</span>
<span class="tt">[% File.isdir %]</span>    # 1</pre>
                    <p>
                      If the <code>stat()</code> on the file fails (e.g. file doesn't exists,
                      bad permission, etc) then the constructor will throw a <code>File</code>
                      exception. This can be caught within a <code>TRY...CATCH</code> block.
                    </p>
                    <pre><span class="tt">[% TRY %]</span>
   <span class="tt">[% USE File('/tmp/myfile') %]</span>
   File exists!
<span class="tt">[% CATCH File %]</span>
   File error: <span class="tt">[% error.info %]</span>
<span class="tt">[% END %]</span></pre>
                    <p>
                      Note the capitalisation of the exception type, '<code>File</code>', to
                      indicate an error thrown by the <code>File</code> plugin, to distinguish
                      it from a regular <code>file</code> exception thrown by the Template
                      Toolkit.
                    </p>
                    <p>
                      Note that the <code>File</code> plugin can also be referenced by the
                      lower case name '<code>file</code>'. However, exceptions are always
                      thrown of the <code>File</code> type, regardless of the capitalisation of
                      the plugin named used.
                    </p>
                    <pre><span class="tt">[% USE file('foo.html') %]</span>
<span class="tt">[% file.mtime %]</span></pre>
                    <p>
                      As with any other Template Toolkit plugin, an alternate name can be
                      specified for the object created.
                    </p>
                    <pre><span class="tt">[% USE foo = file('foo.html') %]</span>
<span class="tt">[% foo.mtime %]</span></pre>
                    <p>
                      The <code>nostat</code> option can be specified to prevent the plugin
                      constructor from performing a <code>stat()</code> on the file specified.
                      In this case, the file does not have to exist in the file system, no
                      attempt will be made to verify that it does, and no error will be thrown
                      if it doesn't. The entries for the items usually returned by
                      <code>stat()</code> will be set empty.
                    </p>
                    <pre><span class="tt">[% USE file('/some/where/over/the/rainbow.html', nostat=1) 
[% file.mtime %]</span>     # nothing</pre>
              </div>
            </div>
            <div class="section">
              <div class="head">
                <h1 id="METHODS" onclick="switch_section(this)" title="Click title to show/hide section content.">METHODS</h1>
                <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
              </div>
              <div class="body">
                <p>
                      All <code>File</code> plugins, regardless of the <code>nostat</code>
                      option, have set a number of items relating to the original path
                      specified.
                    </p>
                    <div class="subsection">
                  <div class="head">
                    <h2 id="section_path" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">path</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          The full, original file path specified to the constructor.
                        </p>
                        <pre><span class="tt">[% USE file('/foo/bar.html') %]</span>
<span class="tt">[% file.path %]</span>     # /foo/bar.html</pre>
                  </div>
                </div>    <div class="subsection">
                  <div class="head">
                    <h2 id="section_name" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">name</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          The name of the file without any leading directories.
                        </p>
                        <pre><span class="tt">[% USE file('/foo/bar.html') %]</span>
<span class="tt">[% file.name %]</span>     # bar.html</pre>
                  </div>
                </div>    <div class="subsection">
                  <div class="head">
                    <h2 id="section_dir" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">dir</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          The directory element of the path with the filename removed.
                        </p>
                        <pre><span class="tt">[% USE file('/foo/bar.html') %]</span>
<span class="tt">[% file.name %]</span>     # /foo</pre>
                  </div>
                </div>    <div class="subsection">
                  <div class="head">
                    <h2 id="section_ext" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">ext</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          The file extension, if any, appearing at the end of the path following a
                          '<code>.</code>' (not included in the extension).
                        </p>
                        <pre><span class="tt">[% USE file('/foo/bar.html') %]</span>
<span class="tt">[% file.ext %]</span>      # html</pre>
                  </div>
                </div>    <div class="subsection">
                  <div class="head">
                    <h2 id="section_home" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">home</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          This contains a string of the form '<code>../..</code>' to represent the
                          upward path from a file to its root directory.
                        </p>
                        <pre><span class="tt">[% USE file('bar.html') %]</span>
<span class="tt">[% file.home %]</span>     # nothing

<span class="tt">[% USE file('foo/bar.html') %]</span>
<span class="tt">[% file.home %]</span>     # ..

<span class="tt">[% USE file('foo/bar/baz.html') %]</span>
<span class="tt">[% file.home %]</span>     # ../..</pre>
                  </div>
                </div>    <div class="subsection">
                  <div class="head">
                    <h2 id="section_root" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">root</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          The <code>root</code> item can be specified as a constructor argument,
                          indicating a root directory in which the named file resides. This is
                          otherwise set empty.
                        </p>
                        <pre><span class="tt">[% USE file('foo/bar.html', root='/tmp') %]</span>
<span class="tt">[% file.root %]</span>     # /tmp</pre>
                  </div>
                </div>    <div class="subsection">
                  <div class="head">
                    <h2 id="section_abs" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">abs</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          This returns the absolute file path by constructing a path from the
                          <code>root</code> and <code>path</code> options.
                        </p>
                        <pre><span class="tt">[% USE file('foo/bar.html', root='/tmp') %]</span>
<span class="tt">[% file.path %]</span>     # foo/bar.html
<span class="tt">[% file.root %]</span>     # /tmp
<span class="tt">[% file.abs %]</span>      # /tmp/foo/bar.html</pre>
                  </div>
                </div>    <div class="subsection">
                  <div class="head">
                    <h2 id="method_rel" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">rel(path)</h2>
                    <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
                  </div>
                  <div class="body">
                    <p>
                          This returns a relative path from the current file to another path
                          specified as an argument. It is constructed by appending the path to the
                          '<code>home</code>' item.
                        </p>
                        <pre><span class="tt">[% USE file('foo/bar/baz.html') %]</span>
<span class="tt">[% file.rel('wiz/waz.html') %]</span>      # ../../wiz/waz.html</pre>
                  </div>
                </div>
              </div>
            </div>
            <div class="section">
              <div class="head">
                <h1 id="EXAMPLES" onclick="switch_section(this)" title="Click title to show/hide section content.">EXAMPLES</h1>
                <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
              </div>
              <div class="body">
                <pre><span class="tt">[% USE file('/foo/bar/baz.html') %]</span>

<span class="tt">[% file.path  %]</span>      # /foo/bar/baz.html
<span class="tt">[% file.dir   %]</span>      # /foo/bar
<span class="tt">[% file.name  %]</span>      # baz.html
<span class="tt">[% file.home  %]</span>      # ../..
<span class="tt">[% file.root  %]</span>      # ''
<span class="tt">[% file.abs   %]</span>      # /foo/bar/baz.html
<span class="tt">[% file.ext   %]</span>      # html
<span class="tt">[% file.mtime %]</span>      # 987654321
<span class="tt">[% file.atime %]</span>      # 987654321
<span class="tt">[% file.uid   %]</span>      # 500
<span class="tt">[% file.user  %]</span>      # abw

<span class="tt">[% USE file('foo.html') %]</span>

<span class="tt">[% file.path %]</span>           # foo.html
<span class="tt">[% file.dir  %]</span>       # ''
<span class="tt">[% file.name %]</span>           # foo.html
<span class="tt">[% file.root %]</span>       # ''
<span class="tt">[% file.home %]</span>       # ''
<span class="tt">[% file.abs  %]</span>       # foo.html

<span class="tt">[% USE file('foo/bar/baz.html') %]</span>

<span class="tt">[% file.path %]</span>           # foo/bar/baz.html
<span class="tt">[% file.dir  %]</span>       # foo/bar
<span class="tt">[% file.name %]</span>           # baz.html
<span class="tt">[% file.root %]</span>       # ''
<span class="tt">[% file.home %]</span>       # ../..
<span class="tt">[% file.abs  %]</span>       # foo/bar/baz.html

<span class="tt">[% USE file('foo/bar/baz.html', root='/tmp') %]</span>

<span class="tt">[% file.path %]</span>           # foo/bar/baz.html
<span class="tt">[% file.dir  %]</span>       # foo/bar
<span class="tt">[% file.name %]</span>           # baz.html
<span class="tt">[% file.root %]</span>       # /tmp
<span class="tt">[% file.home %]</span>       # ../..
<span class="tt">[% file.abs  %]</span>       # /tmp/foo/bar/baz.html

# calculate other file paths relative to this file and its root
<span class="tt">[% USE file('foo/bar/baz.html', root =&gt; '/tmp/tt2') %]</span>

<span class="tt">[% file.path('baz/qux.html') %]</span>         # ../../baz/qux.html
<span class="tt">[% file.dir('wiz/woz.html')  %]</span>     # ../../wiz/woz.html</pre>
              </div>
            </div>
            <div class="section">
              <div class="head">
                <h1 id="AUTHORS" onclick="switch_section(this)" title="Click title to show/hide section content.">AUTHORS</h1>
                <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
              </div>
              <div class="body">
                <p>
                      Michael Stevens wrote the original <code>Directory</code> plugin on which
                      this is based. Andy Wardley split it into separate <code>File</code> and
                      <code>Directory</code> plugins, added some extra code and documentation
                      for <code>VIEW</code> support, and made a few other minor tweaks.
                    </p>
              </div>
            </div>
            <div class="section">
              <div class="head">
                <h1 id="COPYRIGHT" onclick="switch_section(this)" title="Click title to show/hide section content.">COPYRIGHT</h1>
                <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
              </div>
              <div class="body">
                <p>
                      Copyright 2000-2007 Michael Stevens, Andy Wardley.
                    </p>
                    <p>
                      This module is free software; you can redistribute it and/or modify it
                      under the same terms as Perl itself.
                    </p>
              </div>
            </div>
            <div class="section">
              <div class="head">
                <h1 id="SEE_ALSO" onclick="switch_section(this)" title="Click title to show/hide section content.">SEE ALSO</h1>
                <a href="#body" class="top" title="Back up to the top of the page" >Top</a>
              </div>
              <div class="body">
                <p>
                      <a href="../../../modules/Template/Plugin.html">Template::Plugin</a>, <a
                      href="../../../modules/Template/Plugin/Directory.html">Template::Plugin::Directory</a>, <a href="../../../modules/Template/View.html">Template::View</a>
                    </p>
              </div>
            </div>
            
            </div></div>
          <br class="clear" />
          <div class="pageinfo">
            <a href="http://template-toolkit.org/docs/modules/Template/Plugin/File.html">http://template-toolkit.org/docs/modules/Template/Plugin/File.html</a>
          </div>
        </div>
        
        <div id="footer">
          <a href="http://opensource.org/" class="osi"></a>
          <div class="controls">
          <div class="pager">
            <a href="../../../modules/Template/Plugin/Dumper.html" title="Template::Plugin::Dumper" class="go back">Back<span class="about"><h4>Template::Plugin::Dumper</h4></span></a>
            <a href="../../../modules/Template/Plugin/index.html" title="Template::Plugin::* Modules" class="go up">Up<span class="about"><h4>Template::Plugin::* Modules</h4></span></a>
            <a href="../../../modules/Template/Plugin/Filter.html" title="Template::Plugin::Filter" class="go next">Next<span class="about"><h4>Template::Plugin::Filter</h4></span></a>
          </div>
          </div>
          <div class="copyright">
            Copyright &copy; 1996-2012 <a href="http://wardley.org/">Andy Wardley</a>.  All Rights Reserved.
          </div>
          <div class="licence">
            The <a href="http://template-toolkit.org/">Template Toolkit</a> is <a href="http://opensource.org/">Open Source</a> software.
            You can redistribute and/or modify it under the terms of the <a href="http://www.opensource.org/licenses/gpl-license.php">GNU Public Licence</a>
            or the <a href="http://www.opensource.org/licenses/artistic-license.php">Perl Artistic Licence</a>.
          </div>
        </div>
        <div id="palette">
          <ul>
            <li class="first"><a href="#" class="blue" onclick="set_style('Clear Blue')"></a></li>
            <li><a href="#" class="orange" onclick="set_style('Clear Orange')"></a></li>
            <li><a href="#" class="green" onclick="set_style('Clear Green')"></a></li>
            <li><a href="#" class="purple" onclick="set_style('Clear Purple')"></a></li>
            <li><a href="#" class="grey" onclick="set_style('Clear Grey')"></a></li>
          </ul>
        </div>
    </div>  </body>
</html>