Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
ionen-angewandte-physik
AG-Wester
bibtools
Commits
a95272b4
Commit
a95272b4
authored
Sep 09, 2019
by
User expired
Browse files
doc: Documentation revised and Makefile fixed
parent
c813f0e4
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
16 additions
and
14 deletions
+16
-14
Makefile
Makefile
+2
-2
README.rst
README.rst
+14
-12
No files found.
Makefile
View file @
a95272b4
...
...
@@ -26,9 +26,9 @@ doc: README.html doc/bibtools.pdf
clean
:
$(
if
$(
wildcard
$(CLEAN)
)
,
$(RM)
$(
wildcard
$(CLEAN)
))
%.html
:
%.
md
%.html
:
%.
rst
$(
if
$(
shell
which rst2html
)
,rst2html
-t
$(STYLE)
$<
$@
,
\
$
(
info Please
install
'python-docutils'
to create html documentation.
))
)
$
(
info Please
install
'python-docutils'
to create html documentation.
))
doc/bibtools.pdf
:
doc/bibtools.tex $(wildcard doc/figures/*.jpg)
cd
doc
&&
latexmk
-pdf
bibtools
&&
latexmk
-c
bibtools
...
...
README.rst
View file @
a95272b4
...
...
@@ -2,6 +2,11 @@
Command line tools for bibtex citations
=======================================
:Author: Bjoern Bastian
:Date: 2019-09-09
This projects contains several shell scripts for the following tasks.
- Generate file names and citation keys
- Format bibtex files
- Abbreviate journal names
...
...
@@ -14,35 +19,32 @@ The html version of this file is created with ``python-docutils``::
make README.html
:Author: Bjoern Bastian
:Date: 2019-09-09
Usage
=====
See online documentation in
[bibtools.pdf](https://bbastian.pavo.uberspace.de/files/bibtools/bibtools.pdf)
or build ``doc/bibtools.pdf`` yourself with ``make doc``.
See online documentation in `bibtools.pdf`_ or build ``doc/bibtools.pdf``
yourself with ``make doc``.
Setup
=====
GNU AWK is required. For Ubuntu you may install the ``gawk`` package::
-
GNU AWK is required. For Ubuntu you may install the ``gawk`` package::
sudo apt-get install gawk
Install scripts to ``$HOME/bin``::
-
Install scripts to ``$HOME/bin``::
make install
Run all or selected tests::
-
Run all or selected tests::
make test # all tests
./test/test_runner pattern...
W
ith one or more filter patterns containing the wildcard ``*``. Otherwise,
w
ith one or more filter patterns containing the wildcard ``*``. Otherwise,
usual regular expressions are supported, for example ``testJournal[UD]*``.
R
emove scripts from ``$HOME/bin``::
- To uninstall, r
emove scripts from ``$HOME/bin``::
make uninstall
.. _bibtools.pdf: https://bbastian.pavo.uberspace.de/files/bibtools/bibtools.pdf
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment