Installation and Dependencies
unburden-home-dir is a stand-alone Perl script which requires a few
Perl modules as dependencies.
For now, running
make install as root will install the Perl script
and the configuration files to
/usr/. You can prefix by
setting DESTDIR as make flag, e.g.
A more streamlined installation system (either Autotools or something CPAN-compatible) is planned.
Besides installing from source code, several Linux distributions ship unburden-home-dir as package:
Release Version Numbers
- While there’s a leading zero in the version number, the meaning is
- Trailing zeroes are omitted.
Required Run-Time Dependencies
Availability in Debian
With one exception, all mentioned Perl Modules are available in Debian for quite some Stable releases now.
Only the package libstring-expand-perl is rather new and only available in Debian Testing at the time of writing. It likely will be available in Debian Stable with the release of Debian 9 Stretch. (Actually I packaged it for Debian to be able to use it in unburden-home-dir.)
rsync(actually a dependency of
Optional Run-Time Dependencies
Build-Time and Test-Suite Dependencies
Besides all of the run-time dependencies mentioned above (including the optional ones), running the test suite (and hence the full build or packaging process) additionally needs:
For Generating the Documentation
ronn(Yes, Ruby): for generating the man pages from Markdown files.
Availability in Debian
The package mkdocs is rather new and only available in Debian Testing at the time of writing. It likely will be available in Debian Stable with the release of Debian 9 Stretch.
Notes about generating documentation with Python and Ruby based tools
Despite I’m quite happy with the feature set of
Read the Docs, I’d prefer to have pure
Perl tools to generate the documentation so that I can upload
unburden-home-dir to CPAN at some point without having too many
So if you know a suitable perl-written tool which can generate HTML including a table of contents from a set of Markdown files and/or a perl-written tool which can generate Unix manual pages from Markdown, I’d be happy if you would inform me.
Another option would be to use POD instead of Markdown as default documentation format. That would also work on Github (they can parse POD) and there are well-known converters from POD to roff and HTML and at least also one converter from POD to Markdown. The question is only if that can be combined with Read the Docs which seems to require the Markdown files being in the Git repository, not generated from it.
I’ve filed a wishlist request against Read the Docs to also support POD as input format, but it has been rejected.