diff options
author | Stuart Rackham <srackham@methods.co.nz> | 2008-12-12 17:07:41 +1300 |
---|---|---|
committer | Stuart Rackham <srackham@methods.co.nz> | 2008-12-12 17:07:41 +1300 |
commit | 340ffe63e5d668bd346389f942c58dedc567ca2b (patch) | |
tree | 9b149c52c27ff41bc82db0f76dcc24faae8b9f9e | |
parent | d767df6d0ad5e9015121036091d0f79bab26d528 (diff) | |
download | asciidoc-340ffe63e5d668bd346389f942c58dedc567ca2b.tar.gz |
- Added uninstall target to Makefile.in.
- Makefile.in updates.
- Documented Makefile based installer.
-rw-r--r-- | INSTALL.txt | 39 | ||||
-rw-r--r-- | MANIFEST | 4 | ||||
-rw-r--r-- | Makefile.in | 55 | ||||
-rwxr-xr-x | asciidoc.py | 3 | ||||
-rw-r--r-- | configure.ac | 2 | ||||
-rw-r--r-- | doc/asciidoc.txt | 28 | ||||
-rw-r--r-- | main.aap | 2 |
7 files changed, 70 insertions, 63 deletions
diff --git a/INSTALL.txt b/INSTALL.txt index d27708c..acfc443 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -19,33 +19,32 @@ lists AsciiDoc packages for various Linux distributions. Distribution tarball installation --------------------------------- -If your flavor or UNIX or Linux is not supported or you prefer to -install from source use the `install.sh` shell script in the tarball -root directory (thanks to mailto:jlm@ofb.net[Jacob Mandelson] for the -initial implementation of this script). +If your flavor or UNIX or Linux does not have a packaged AsciiDoc +distribution or if you prefer to install from source use the +`configure` shell script in the tarball root directory. -`install.sh` installs AsciiDoc executables, configuration files and -man pages in the usual locations. Here's how: +The `autoconf(1)` generated `configure` script creates a make file +that is tailored for you system. To install: -[subs="normal"] +[subs="attributes"] $ tar -xzf asciidoc-{revision}.tar.gz $ cd asciidoc-{revision} - $ sudo ./install.sh + $ ./configure + $ sudo make + $ sudo make install -NOTE: This script was tested on Ubuntu Linux. You may need to edit -`install.sh` if your file locations differ from those wired into the -script. +To install the documentation: -The `uninstall.sh` script (actually just a symlink to `install.sh`) -will uninstall AsciiDoc. + $ sudo make docs -If Vim is installed on your system `install.sh` will install the Vim -syntax highlighter and filetype detection scripts in the global -`/etc/vim` directory (`asciidoc.vim` in `/etc/vim/syntax/` and -`asciidoc_filetype.vim` in `/etc/vim/ftdetect/`). +To uninstall AsciiDoc: -To install locally put `asciidoc.vim` in `\~/.vim/syntax/` and -`asciidoc_filetype.vim` in `~/.vim/ftdetect/`. + $ sudo make uninstall + +If Vim is installed on your system syntax highlighter and filetype +detection scripts will be install in the global Vim configuration file +directory (`asciidoc.vim` in the `syntax` directory and +`asciidoc_filetype.vim` in the `ftdetect` directory). Microsoft Windows installation @@ -53,7 +52,7 @@ Microsoft Windows installation To install the zip formatted distribution just unzip the contents to a new folder: -[subs="normal"] +[subs="attributes"] $ mkdir asciidoc $ cd asciidoc $ unzip ../asciidoc-{revision}.zip @@ -63,10 +63,10 @@ images/smallnew.png images/tiger.png images/highlighter.png INSTALL +INSTALL.txt +configure configure.ac Makefile.in -uninstall.sh -INSTALL.txt javascripts/ASCIIMathML.js javascripts/LaTeXMathML.js javascripts/toc.js diff --git a/Makefile.in b/Makefile.in index 678ff40..348f06e 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1,3 +1,7 @@ +# +# Make file to install/uninstall AsciiDoc +# + INSTALL = @INSTALL@ INSTALL_PROG = @INSTALL_PROGRAM@ INSTALL_DATA = @INSTALL_DATA@ @@ -29,10 +33,10 @@ manpdir = $(mandir)/man1 conf = $(wildcard *.conf) confdir = $(ASCIIDOCCONF) -filters = $(wildcard filters/*.py) +filters = $(wildcard filters/*.py) $(wildcard filters/*.conf) filtersdir = $(ASCIIDOCCONF)/filters -docbook = $(wildcard docbook-xsl/*xsl) +docbook = $(wildcard docbook-xsl/*.xsl) docbookdir = $(ASCIIDOCCONF)/docbook-xsl dblatex = $(wildcard dblatex/*.xsl) $(wildcard dblatex/*.sty) @@ -73,17 +77,20 @@ $(PROGTARGETS): % : %dir $(DATATARGETS): % : %dir $(INSTALL_DATA) $($@) $(DESTDIR)/$($<)/ -vim: - $(INSTALL) -d $(DESTDIR)/$(vimdir)/syntax - $(INSTALL_DATA) vim/syntax/asciidoc.vim $(DESTDIR)/$(vimdir)/syntax/ - $(INSTALL) -d $(DESTDIR)/$(vimdir)/ftdetect - $(INSTALL_DATA) vim/ftdetect/asciidoc_filetype.vim \ - $(DESTDIR)/$(vimdir)/ftdetect/ - -docs: docdir +docs: $(INSTALL_DATA) $(doc) $(DESTDIR)/$(docdir) + $(INSTALL) -d $(DESTDIR)/$(docdir)/stylesheets + $(INSTALL_DATA) $(css) $(DESTDIR)/$(docdir)/stylesheets + $(INSTALL) -d $(DESTDIR)/$(docdir)/javascripts + $(INSTALL_DATA) $(js) $(DESTDIR)/$(docdir)/javascripts + $(INSTALL) -d $(DESTDIR)/$(docdir)/images + ( cd images && \ + cp -R * $(DESTDIR)/$(docdir)/images ) + $(INSTALL) -d $(DESTDIR)/$(docdir)/doc + ( cd doc && \ + cp -R * $(DESTDIR)/$(docdir)/doc ) $(INSTALL) -d $(DESTDIR)/$(docdir)/examples/website - ( cd examples/website; \ + ( cd examples/website && \ cp -R * $(DESTDIR)/$(docdir)/examples/website ) linkpy: @@ -96,12 +103,32 @@ fixconfpath: mv $$f.out $$f; \ done +install-vim: + test -d $(DESTDIR)/$(vimdir) && \ + $(INSTALL) -d $(DESTDIR)/$(vimdir)/syntax + test -d $(DESTDIR)/$(vimdir) && \ + $(INSTALL_DATA) vim/syntax/asciidoc.vim $(DESTDIR)/$(vimdir)/syntax/ + test -d $(DESTDIR)/$(vimdir) && \ + $(INSTALL) -d $(DESTDIR)/$(vimdir)/ftdetect + test -d $(DESTDIR)/$(vimdir) && \ + $(INSTALL_DATA) vim/ftdetect/asciidoc_filetype.vim \ + $(DESTDIR)/$(vimdir)/ftdetect/ + build: fixconfpath -install: $(PROGTARGETS) $(DATATARGETS) linkpy docs +install: $(PROGTARGETS) $(DATATARGETS) linkpy install-vim -install-vim: vim +uninstall: + rm -f $(DESTDIR)/$(progdir)/asciidoc + rm -f $(DESTDIR)/$(progdir)/asciidoc.py + rm -f $(DESTDIR)/$(progdir)/a2x + rm -f $(DESTDIR)/$(mandir)/asciidoc.1 + rm -f $(DESTDIR)/$(mandir)/a2x.1 + rm -rf $(DESTDIR)/$(confdir) + rm -f $(DESTDIR)/$(vimdir)/syntax/asciidoc.vim + rm -f $(DESTDIR)/$(vimdir)/ftdetect/asciidoc_filetype.vim + rm -rf $(DESTDIR)/$(docdir) test: - @echo "Nothing to see here...Move along."
\ No newline at end of file + @echo "Nothing to see here...Move along." diff --git a/asciidoc.py b/asciidoc.py index ed826cd..cff4196 100755 --- a/asciidoc.py +++ b/asciidoc.py @@ -4664,7 +4664,8 @@ class Tables_OLD(AbstractBlocks): APP_FILE = None # This file's full path. APP_DIR = None # This file's directory. USER_DIR = None # ~/.asciidoc -CONF_DIR = '/etc/asciidoc' # Global configuration files directory. +# Global configuration files directory (set by Makefile build target). +CONF_DIR = '/etc/asciidoc' HELP_FILE = 'help.conf' # Default (English) help file. # Globals diff --git a/configure.ac b/configure.ac index 6de4c79..ce855f0 100644 --- a/configure.ac +++ b/configure.ac @@ -1,4 +1,4 @@ -AC_INIT(asciidoc, 8.2.7) +AC_INIT(asciidoc, 8.3.1) AC_CONFIG_FILES(Makefile) diff --git a/doc/asciidoc.txt b/doc/asciidoc.txt index 8730b5e..0f44d20 100644 --- a/doc/asciidoc.txt +++ b/doc/asciidoc.txt @@ -4797,31 +4797,9 @@ Appendix B: Packager Notes Read the `README` and `INSTALL` files (in the distribution root directory) for install prerequisites and procedures. -The distribution `install.sh` shell script is the canonical -installation procedure and is the definitive installation description. -Here's a summary of the installation procedure: - -- Unpack entire distribution tarball to `/usr/share/asciidoc/`. -- Move `asciidoc.py` to `/usr/bin/`; rename to `asciidoc`; if - necessary modify shebang line; ensure executable permissions are - set. -- Move `a2x` to `/usr/bin/`; if necessary modify shebang line; ensure - executable permissions are set. -- Move the `./*.conf` files to `/etc/asciidoc/`. -- Move `./filters/{\*.conf,*.py}` to `/etc/asciidoc/filters/`. -- Move `./docbook-xsl/*.xsl` to `/etc/asciidoc/docbook-xsl/`. -- Move `./dblatex/*.{xsl,sty}` to `/etc/asciidoc/dblatex/`. -- Copy `./stylesheets/*.css` to `/etc/asciidoc/stylesheets/`. -- Copy `./javascripts/*.js` to `/etc/asciidoc/javascripts/`. -- Copy `./images/icons/*` to `/etc/asciidoc/images/icons/` - (recursively including the `icons` subdirectory and its contents). -- Compress the asciidoc(1) and ax2(1) man pages (`./doc/*.1`) with - gzip(1) and move them to `/usr/share/man/man1/`. -- If Vim is installed then install Vim syntax and filetype detection - files. - -Leaving stylesheets and images in `/usr/share/asciidoc/` ensures the -docs and example website are not broken. +The distribution `Makefile.in` (used by `configure` to generate the +actual `Makefile`) is the canonical installation procedure. Here's a +summary of the installation procedure: [[X39]] @@ -24,6 +24,8 @@ website: :execute ./examples/website/main.aap distribution: docs website + # Make configure script. + autoconf # Make tarball of all files in MANIFEST. :syseval pwd | :assign WD :sys cd .. && ln -s $(WD) asciidoc-$(VERS) |