wiki:WikiStart

Version 13 (modified by ulrich, 14 years ago) (diff)

--

Description

The provided script written in python provides a LaTeX compatible output for use with the dirtree package. So one can display directory trees which are generated right at the time when the document is generated. I use makefiles for generating my documents with pdflatex and bibtex and then simply add a few lines to use this small script.

The work on this script won't go on continously, but I hope that I add the planned features mentioned below in the near future. If you are interested in the ongoing process of this small tool, you may add the rss feed of the timeline page to your favourite news- feed- program like KDEs Akregator or Mozillas Thunderbird.

If you have ideas to improve this script email them to me, please. You may check the current version of this script out from https://svn.falaba.de/dirs-script anonymously, change it and email the new source to dirs-script@….

If you just want to download the script, please use the tarball.

Motivation

The motivation for me writing this script came to me, when I was writing the documentation for a project at the University and wanted to show our directory layout of our project repositories. I did not want to write all this directories down by hand and even worse keeping it up-to-date.

I did not wrote the script in bash, because I wanted some windows compatibility, and so I decided to write it in python.

Features

current

  • one can exclude directories from processing
  • one can use .comment files to print comments behind the listed directory in which the file lies
  • one can specify an other file to use as comment file

planned

  • one let the script print directory sizes as comment or at the beginning of the comment
  • one can specify if files should be considered, specified closer as
    • hidden files
    • file properties (owner, executable, special...)
    • seperate exclude list

Notes

Tex Include Directories

You may want every user on the system to be able to use tex packages without downloading them seperatedly or just save the time searching the same packages multiple times. The solution is to extend the tex search path. I did that for all users on my system by adding following line to the bash configuration file /etc/bash.bashrc.

export TEXINPUTS=".:/usr/local/share/latex//:"

The doubled slash at the end of the path causes tex to recursively check this directory for searched packages. Click here for more information.

Other shells may require other commands. Use appropriate permissions for that folder like owner root may write, everyone else just read.