aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorMattias Andrée <maandree@member.fsf.org>2015-12-19 01:34:13 +0100
committerMattias Andrée <maandree@member.fsf.org>2015-12-19 01:34:13 +0100
commitefd9790d1d98488b11495222057d6d4afa97718d (patch)
tree5ab03eb6b05712bcecb5f4fffbf3be9ccfd09743 /INSTALL
parentm gitignore (diff)
downloadsleeping-getty-efd9790d1d98488b11495222057d6d4afa97718d.tar.gz
sleeping-getty-efd9790d1d98488b11495222057d6d4afa97718d.tar.bz2
sleeping-getty-efd9790d1d98488b11495222057d6d4afa97718d.tar.xz
add deps + add install + add news + add build system
Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
Diffstat (limited to '')
-rw-r--r--INSTALL98
1 files changed, 98 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..bb33e41
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,98 @@
+Type './configure --help' for configuration options. The normal settings for a
+GNU package should work. If not, please make a bug report.
+
+ On a common GNU/Linux distribution the following should
+ be sufficient for most users:
+
+ ./configure --prefix=/usr
+ make
+ make install DESTDIR="somewhere you want the files for now"
+ # Now let the package manager put the files in place...
+
+ Or for an unstaged install:
+
+ ./configure --prefix=/usr
+ make
+ sudo make install
+
+By default any applicable pre-install, post-install, pre-uninstall, and
+post-install commands is run. This suppress these, run 'make' with 'N=true'
+or 'N=:'. IF you want to know which these commands are, you can use the
+methods specificed in the GNU Coding Standards. Another method is found in
+mk/README. However, for this packages, these will be:
+
+ infodir="usr/local/share/info" ## Assuming default prefix.
+
+ post_install () {
+ install-info -- "${infodir}/sleeping-getty.info" "${infodir}/dir"
+ }
+
+ pre_uninstall () {
+ install-info --delete -- "${infodir}/sleeping-getty.info" "${infodir}/dir"
+ }
+
+
+────────────────────────────────────────────────────────────────────────────────
+INTERNATIONALISATION
+────────────────────────────────────────────────────────────────────────────────
+
+You can select which translations of the man page you
+want to install too:
+
+ ./configure MAN_LOCALES=sv
+
+(Note, there are no translation as of yet.)
+
+
+────────────────────────────────────────────────────────────────────────────────
+CUSTOMISED COMPILATION
+────────────────────────────────────────────────────────────────────────────────
+
+The makefile is configured to compile the C code with -O2 -g, you can
+change this by setting OPTIMISE, or with CFLAGS and LDFLAGS if you want
+to change all optional flags compiling and linking flags:
+
+ ./configure OPTIMISE="-Og -g"
+
+
+────────────────────────────────────────────────────────────────────────────────
+CUSTOMISED INSTALLATION
+────────────────────────────────────────────────────────────────────────────────
+
+If you want to install absolutely everything, you can
+instead use the commands below:
+
+ make everything
+ make install-everything DESTDIR="pkg"
+
+Or if you only want to absolute basics:
+
+ make base
+ make install-base DESTDIR="pkg"
+
+You can select freely what parts of the package to install and not
+to install. This rules are available:
+
+┌─────────────┬─────────────────────┬────────────────────────────────────────────┐
+│ COMPILATION │ INSTALLATION │ DESCRIPTION │
+├─────────────┼─────────────────────┼────────────────────────────────────────────┤
+│ base │ install-base │ Install be basics: │
+│ cmd │ install-cmd │ Install the sleeping-getty command. │
+│ │ install-copyright │ Install GNU GPL version 3. │
+│ doc │ install-doc │ Include all manuals: │
+│ info │ install-info │ Include info manual. (Texinfo) │
+│ dvi │ install-dvi │ Include DVI manual. (Texinfo) │
+│ pdf │ install-pdf │ Include PDF manual. (Texinfo) │
+│ ps │ install-ps │ Include PostScript manual. (Texinfo) │
+│ html │ install-html │ Include multifile HTML manual. (Texinfo) │
+│ │ install-man │ Include man pages. │
+└─────────────┴─────────────────────┴────────────────────────────────────────────┘
+
+install, install-everything, install-base, and install-cmd, have alternatives
+that installs a stripped binary: install-strip, install-everything-strip,
+install-base-strip, and install-cmd-strip, respectively.
+
+The untranslated man page is installed via the rule install-man-untranslated.
+Additional translations are installed via the rule install-man-locale, which
+installs the locales listed in MAN_LOCALES.
+