summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/physunits
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-01-27 21:56:05 +0000
committerKarl Berry <karl@freefriends.org>2020-01-27 21:56:05 +0000
commitc1881c5c5344914a46d0f06387afcb78981a85c5 (patch)
tree0856d11fe6b85ca6bab5388face0faedc6ca9c05 /Master/texmf-dist/doc/latex/physunits
parentc035ae941be8394f01abe2c683458a79c2c1a6ee (diff)
physunits (27jan20)
git-svn-id: svn://tug.org/texlive/trunk@53574 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/physunits')
-rw-r--r--Master/texmf-dist/doc/latex/physunits/CHANGELOG.md39
-rw-r--r--Master/texmf-dist/doc/latex/physunits/README.md81
-rw-r--r--Master/texmf-dist/doc/latex/physunits/makefile122
-rw-r--r--Master/texmf-dist/doc/latex/physunits/physunits.pdfbin0 -> 100908 bytes
4 files changed, 242 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/physunits/CHANGELOG.md b/Master/texmf-dist/doc/latex/physunits/CHANGELOG.md
new file mode 100644
index 00000000000..5ccb30dc100
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physunits/CHANGELOG.md
@@ -0,0 +1,39 @@
+# Changes
+## [1.0.0] - 2020/01/22
+- Initial version
+## [1.0.1] - 2020/01/25
+### Added
+- A changelog
+- A readme
+- Code for changelog into physconst.cpp
+- `make dist` to create distributable tarball and zip
+- line in .ins to force generation of the .sty
+- nicer index entries (and some associated code in .cpp to generate them)
+- added localuninstall and distuninstall targets to the makefile
+### Changed
+- Modified the makefile to split up generation of the .sty, and .pdf
+- Added a newline in the middle of the title declaration (in .cpp)
+- Added a newline in the middle of the \DoNotIndex declaration (in .cpp)
+- fixed makefile install options to correctly find TEXMF path
+## [1.0.2] - 2020/01/25
+### Changed
+- Switch compression of tarball to gzip to match requirement for CTAN
+## [1.0.3] - 2020/01/26
+### Added
+- uninstall instructions in README.md
+- installcheck in makefile
+- force makefile to be run serial
+### Changed
+- Switch tarball/zip to include .dtx instead of .sty per CTAN requirement
+- Clean up installation instructions in README.md
+- Made some changes in the makefile to take better advantage of make
+## [1.0.3a] - 2020/01/26
+### Added
+- Created a separate readme for the distribution
+- Created a separate makefile for the distribution
+### Changed
+- modify the makefile to include .ins in the package files
+- modify the makefile to include the new distrubution readme and makefile
+- give instructions on using makefile for distribution
+- Did a little more reformatting in the README.
+
diff --git a/Master/texmf-dist/doc/latex/physunits/README.md b/Master/texmf-dist/doc/latex/physunits/README.md
new file mode 100644
index 00000000000..ce400e3487e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physunits/README.md
@@ -0,0 +1,81 @@
+# physunits
+A LaTeX package that includes macros for SI, cgs, and some imperial units.
+
+# License
+Copyright (C) 2020 by Brian W. Mulligan <bwmulligan@astronaos.com>
+-----------------------------------------------------------
+
+This file may be distributed and/or modified under the conditions of
+the LaTeX Project Public License, either version 1.3c of this license
+or (at your option) any later version. The latest version of this
+license is in:
+
+http://www.latex-project.org/lppl.txt
+
+and version 1.3c or later is part of all distributions of LaTeX
+version 2006/05/20 or later.
+
+# Dependencies
+None.
+
+# Build Dependencies
+- some LaTeX distribution.
+- `hyperref` package for LaTeX
+
+# Files
+```
+ makefile GNU makefile to simplify building and installation on linux
+ README.md This file.
+ CHANGELOG.md List of changes
+ physunits.ins The installer file
+ physunits.dtx The package code and documentation
+ physunits.pdf The package user manual
+```
+
+# Building the Package
+## Linux / Mac using make and xelatex
+1. `make`
+
+## Otherwise
+1. Run `latex` on `physunits.ins` to create the `.sty` file. e.g. `latex physunits.ins`.
+1. The following steps apply only if you want the documentation (recommended).
+ 1. Run `latex` on `physunits.dtx` to create the `.pdf` file. e.g. `xelatex physunits.pdf`.
+ 1. Run `makeindex` to create the index, e.g. `makeindex -s gind.ist -o physunits.ind physunits.idx`.
+ 1. Run `makeindex` to create the change log, e.g. `makeindex -s gglo.ist -o physunits.gls physunits.glo`.
+ 1. Run `latex` on `physunits.dtx` to create the `.pdf` file with index and change log. e.g. `xelatex physunits.pdf`.
+ 1. Run `latex` on `physunits.dtx` to get the labels sorted out. e.g. `xelatex physunits.pdf`.
+
+Instructions that might help can be for windows can be found at [this post on StackExchange](https://tex.stackexchange.com/questions/369921/loading-packages-with-ins-and-dtx-files).
+
+# Installation
+First build the project as described above.
+
+## For a single project
+1. Copy the `physunits.sty` into your project where your `.tex` files are located.
+
+## for all users and projects
+### Linux / Mac using make and xelatex
+1. `make localinstall`
+
+### Otherwise
+Instructions that might help can be for windows can be found at [this post on StackExchange](https://tex.stackexchange.com/questions/369921/loading-packages-with-ins-and-dtx-files).
+1. Figure out where your LaTeX local packages are installed.
+1. Create a directory named `physunits` in that location.
+1. Copy the `.sty` file into the directory you just created.
+1. Figure out where your LaTeX local package documentation is installed.
+1. Create a directory named `physunits` in that location.
+1. Copy the `.pdf` file into the directory you just created.
+1. Run `texhash` or the equivalent to let LaTeX know the package is there.
+
+
+# Uninstallation
+
+### Linux / Mac using make
+1. `make localuninstall`
+### Otherwise
+1. Figure out where your LaTeX local packages are installed.
+1. Delete the directory named `physunits` in that location.
+1. Figure out where your LaTeX local package documentation is installed.
+1. Delete the directory named `physunits` in that location.
+1. Run `texhash` or the equivalent to let LaTeX know the package is gone.
+
diff --git a/Master/texmf-dist/doc/latex/physunits/makefile b/Master/texmf-dist/doc/latex/physunits/makefile
new file mode 100644
index 00000000000..ca48c701ecf
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physunits/makefile
@@ -0,0 +1,122 @@
+pkgname=$(patsubst %.ins,%,$(wildcard *.ins))
+TEXMFLOCAL = $(shell kpsewhich -var-value TEXMFLOCAL)
+TEXMFDIST = $(shell kpsewhich -var-value TEXMFDIST)
+
+.PHONY: all clean localinstall localuninstall localinstallcheck distinstall distuninstall distinstallcheck installcheck
+
+all: $(pkgname).pdf
+
+.PRECIOUS: %.sty %.dtx %.pdf
+.DELETE_ON_ERROR:
+.NOTPARALLEL:
+
+%.sty: %.dtx %.ins
+ latex $(pkgname).ins
+
+%.pdf: %.sty
+ xelatex $(pkgname).dtx
+ makeindex -s gind.ist -o $(pkgname).ind $(pkgname).idx
+ makeindex -s gglo.ist -o $(pkgname).gls $(pkgname).glo
+ xelatex $(pkgname).dtx
+ xelatex $(pkgname).dtx
+
+clean:
+ -rm *.pdf
+ -rm *.log
+ -rm *.out
+ -rm *.aux
+ -rm *.bib
+ -rm *.snm
+ -rm *.toc
+ -rm *.nav
+ -rm *.idx
+ -rm *.sty
+ -rm *.gls
+ -rm *.ilg
+ -rm *.ind
+ -rm *.glo
+ -rm $(pkgname).zip
+ -rm $(pkgname).tar
+ -rm $(pkgname).tar.gz
+ -rm -r $(pkgname)
+ -rm -r tmptar
+ -rm -r tmpzip
+
+$(TEXMFLOCAL)/tex/latex/$(pkgname):
+ mkdir -p $(TEXMFLOCAL)/tex/latex/$(pkgname)
+
+$(TEXMFLOCAL)/doc/latex/$(pkgname):
+ mkdir -p $(TEXMFLOCAL)/doc/latex/$(pkgname)
+
+$(TEXMFLOCAL)/tex/latex/$(pkgname)/$(pkgname).sty: $(pkgname).sty $(TEXMFLOCAL)/tex/latex/$(pkgname)
+ cp $(pkgname).sty $(TEXMFLOCAL)/tex/latex/$(pkgname)/.
+
+$(TEXMFLOCAL)/doc/latex/$(pkgname)/$(pkgname).pdf: $(pkgname).pdf $(TEXMFLOCAL)/doc/latex/$(pkgname)
+ cp $(pkgname).pdf $(TEXMFLOCAL)/doc/latex/$(pkgname)/.
+
+localinstall: $(pkgname).pdf $(pkgname).sty $(TEXMFLOCAL)/tex/latex/$(pkgname) $(TEXMFLOCAL)/doc/latex/$(pkgname) $(TEXMFLOCAL)/tex/latex/$(pkgname)/$(pkgname).sty $(TEXMFLOCAL)/doc/latex/$(pkgname)/$(pkgname).pdf
+ @echo Installing to $(TEXMFLOCAL)/tex/latex/$(pkgname)
+ texhash
+ make localinstallcheck
+
+localuninstall:
+ @echo Removing from $(TEXMFLOCAL)/tex/latex/$(pkgname)
+ -rm -r $(TEXMFLOCAL)/tex/latex/$(pkgname)
+ -rm -r $(TEXMFLOCAL)/doc/latex/$(pkgname)
+ texhash
+
+
+$(TEXMFDIST)/tex/latex/$(pkgname):
+ mkdir -p $(TEXMFDIST)/tex/latex/$(pkgname)
+
+$(TEXMFDIST)/doc/latex/$(pkgname):
+ mkdir -p $(TEXMFDIST)/doc/latex/$(pkgname)
+
+$(TEXMFDIST)/tex/latex/$(pkgname)/$(pkgname).sty: $(pkgname).sty $(TEXMFDIST)/tex/latex/$(pkgname)
+ cp $(pkgname).sty $(TEXMFDIST)/tex/latex/$(pkgname)/.
+
+$(TEXMFDIST)/doc/latex/$(pkgname)/$(pkgname).pdf: $(pkgname).pdf $(TEXMFDIST)/doc/latex/$(pkgname)
+ cp $(pkgname).pdf $(TEXMFDIST)/doc/latex/$(pkgname)/.
+
+distinstall: $(pkgname).pdf $(pkgname).sty $(TEXMFDIST)/tex/latex/$(pkgname) $(TEXMFDIST)/doc/latex/$(pkgname) $(TEXMFDIST)/tex/latex/$(pkgname)/$(pkgname).sty $(TEXMFDIST)/doc/latex/$(pkgname)/$(pkgname).pdf
+ @echo Installing to $(TEXMFDIST)/tex/latex/$(pkgname)
+ texhash
+ make distinstallcheck
+
+distuninstall:
+ @echo Removing from $(TEXMFDIST)/tex/latex/$(pkgname)
+ -rm -r $(TEXMFDIST)/tex/latex/$(pkgname)
+ -rm -r $(TEXMFDIST)/doc/latex/$(pkgname)
+ texhash
+
+#######################################################
+# checks - will be called recursively
+#######################################################
+
+localinstallcheck:
+ifeq (0,$(shell test -d $(TEXMFLOCAL)/tex/latex/$(pkgname); echo $$?))
+ @echo $(pkgname) installed as local: $(TEXMFLOCAL)/tex/latex/$(pkgname)
+else
+ $(error $(pkgname) is not installed as local)
+endif
+
+distinstallcheck:
+ifeq (0,$(shell test -d $(TEXMFDIST)/tex/latex/$(pkgname); echo $$?))
+ @echo $(pkgname) installed as dist: $(TEXMFDIST)/tex/latex/$(pkgname)
+else
+ $(error $(pkgname) is not installed as dist)
+endif
+
+installcheck:
+ifeq (0,$(shell test -d $(TEXMFDIST)/tex/latex/$(pkgname); echo $$?))
+ @echo $(pkgname) installed as dist: $(TEXMFDIST)/tex/latex/$(pkgname)
+else
+ifeq (0,$(shell test -d $(TEXMFLOCAL)/tex/latex/$(pkgname); echo $$?))
+ @echo $(pkgname) installed as local: $(TEXMFLOCAL)/tex/latex/$(pkgname)
+else
+ $(error $(pkgname) is not installed)
+endif
+endif
+
+
+
diff --git a/Master/texmf-dist/doc/latex/physunits/physunits.pdf b/Master/texmf-dist/doc/latex/physunits/physunits.pdf
new file mode 100644
index 00000000000..090dfa7d836
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physunits/physunits.pdf
Binary files differ