Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/torch/paths.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkoray kavukcuoglu <koray@kavukcuoglu.org>2012-02-13 09:33:09 +0400
committerkoray kavukcuoglu <koray@kavukcuoglu.org>2012-02-13 09:33:09 +0400
commitae34f3be400dc83d23476f8b50ccfa45043cd304 (patch)
tree4cfc6e54f425f39c919610c4d53106c0c487c738
parent8fdf0ac3391de41b2e00a55a5b02742edf9e3876 (diff)
big pass over documentation to make titles consistent across all packages..
-rw-r--r--dok/index.dok52
1 files changed, 26 insertions, 26 deletions
diff --git a/dok/index.dok b/dok/index.dok
index e118196..6986a98 100644
--- a/dok/index.dok
+++ b/dok/index.dok
@@ -8,7 +8,7 @@ variables indicating where the various Torch components are installed.
Do not change their values.
-==== Manipulating file names ====
+===== Manipulating file names =====
{{anchor:paths.filenames.dok}}
The following functions can be used
@@ -16,32 +16,32 @@ to manipulate filenames in a portable way
over multiple platforms.
-=== paths.filep(path) ===
+==== paths.filep(path) ====
{{anchor:paths.filep}}
Return a boolean indicating whether ''path''
refers to an existing file.
-=== paths.dirp(path) ===
+==== paths.dirp(path) ====
{{anchor:paths.dirp}}
Return a boolean indicating whether ''path''
refers to an existing directory.
-=== paths.basename(path,[suffix]) ===
+==== paths.basename(path,[suffix]) ====
{{anchor:paths.basename}}
Return the last path component of ''path''
and optionally strip the suffix ''suffix''.
This is similar to the well know shell command ''"basename"''.
-=== paths.dirname(path) ===
+==== paths.dirname(path) ====
{{anchor:paths.dirname}}
Return the name of directory containing file ''path''.
This is similar to the well known shell command ''"dirname"''.
-=== paths.concat([path1,....,pathn]) ===
+==== paths.concat([path1,....,pathn]) ====
{{anchor:paths.concat}}
Concatenates relative filenames.
@@ -57,13 +57,13 @@ Calling this function without argument returns the
full name of the current directory.
-=== paths.cwd() ===
+==== paths.cwd() ====
{{anchor:paths.cwd}}
Return the full path of the current directory.
-=== paths.execdir() ===
+==== paths.execdir() ====
{{anchor:paths.execdir}}
Return the name of the directory containing the
@@ -74,21 +74,21 @@ the variables indicating
the location of the various Torch components.
-==== Accessing directories ====
+===== Accessing directories =====
{{anchor:paths.dirs.dok}}
The following functions can be used
to examine directory contents.
-=== paths.dir(dname) ===
+==== paths.dir(dname) ====
{{anchor:paths.dir}}
Return a table containing the files in directory ''dname''.
This function return ''nil'' if the specified directory
does not exists.
-=== paths.files(dname) ===
+==== paths.files(dname) ====
{{anchor:paths.files}}
Returns an iterator over the files located in directory ''dname''.
@@ -100,10 +100,10 @@ This can be used in ***for*** expression as shown below:
</file>
-==== Finding files relative to a Lua script ====
+===== Finding files relative to a Lua script =====
{{anchor:paths.findingfiles.dok}}
-=== paths.thisfile([arg]) ===
+==== paths.thisfile([arg]) ====
{{anchor:paths.thisfile}}
Calling ''paths.thisfile()'' without argument
@@ -120,7 +120,7 @@ for instance, to locate files located in the same
directory as a lua script.
-=== paths.dofile(filename) ===
+==== paths.dofile(filename) ====
{{anchor:paths.dofile}}
This function is similar to the standard Lua function ''dofile''
@@ -129,74 +129,74 @@ the file that contains the call to ''paths.dofile'',
or to the current directory when ''paths.dofile'' is
called interactively.
-==== Well known directories ====
+===== Well known directories =====
{{anchor:paths.wellknowndirs.dok}}
These variables indicate where the various Torch components are installed.
It is not advisable to change their values!
-=== paths.install_prefix ===
+==== paths.install_prefix ====
{{anchor:paths.install_prefix}}
The base directory of the Torch installation.
-=== paths.install_bin ===
+==== paths.install_bin ====
{{anchor:paths.install_bin}}
The name of the directory containing the executable programs.
Under Windows, this directory also contains
the dynamically loadable libraries (''.dll'').
-=== paths.install_man ===
+==== paths.install_man ====
{{anchor:paths.install_man}}
The name of the directory containing the unix style manual pages.
-=== paths.install_lib ===
+==== paths.install_lib ====
{{anchor:paths.install_lib}}
The name of the directory containing the object code libraries.
Under Unix, this directory also contains the dynamically
loadable libraries (''.so'' or ''.dylib'').
-=== paths.install_share ===
+==== paths.install_share ====
{{anchor:paths.install_share}}
The name of the directory containing processor independent data files,
such as lua code and other text files.
-=== paths.install_include ===
+==== paths.install_include ====
{{anchor:paths.install_include}}
The name of the directory containing the include files
for the various Torch libraries.
-=== paths.install_hlp ===
+==== paths.install_hlp ====
{{anchor:paths.install_hlp}}
The name of the directory containing the Torch help files.
-=== paths.install_html ===
+==== paths.install_html ====
{{anchor:paths.install_html}}
The name of the directory containing the HTML version
of the Torch help files. These files are generated
when you enable the CMake option ''HTML_DOC''.
-=== paths.install_cmake ===
+==== paths.install_cmake ====
{{anchor:paths.install_cmake}}
The name of the directory containing the CMake files
used by external Torch modules.
-=== paths.install_lua_path ===
+==== paths.install_lua_path ====
{{anchor:paths.install_lua_path}}
The name of the directory containing the Lua packages.
This directory is used to build variable ''package.path''.
-=== paths.install_lua_cpath ===
+==== paths.install_lua_cpath ====
{{anchor:paths.install_lua_cpath}}
The name of the directory containing the Lua loadable binary modules.