Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 145 lines (107 sloc) 4.342 kb
f45ba61 @JNeitzel Update the [A-Z]* files as needed.
authored
1 Build and install instructions for osh!
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
2
672e62b @JNeitzel Do some documentation cleanup in AUTHORS, NOTES, osh.1.in, and
authored
3 --------
08467bc @JNeitzel
authored
4 SYNOPSIS
5 env [variable=value ...] make [target ...]
6 make [variable=value ...] [target ...]
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
7
08467bc @JNeitzel
authored
8 If the defaults described below match your desires and/or the
9 requirements of your system, you can build and install the entire
795b5d5 @JNeitzel
authored
10 osh package by doing the following.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
11
12 % make
13 # make install
14
15 ...
16 Otherwise, continue reading for full build and install details.
17 See the EXAMPLES section at the end of this file for additional
18 help if needed.
19
20 ---------
08467bc @JNeitzel
authored
21 VARIABLES
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
22 The Makefile defines the following configuration variables (default
23 value listed). The user can modify the default configuration by
24 passing the desired variable=value pair(s) on the command line.
25
1967fd9 @JNeitzel Last sync prior to branching for the osh-20081122 release.
authored
26 DESTDIR Unset by default. This may be used as a
27 target directory for building/packaging
28 binary packages if needed.
29
08467bc @JNeitzel
authored
30 PREFIX Defaults to /usr/local. This is the target
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
31 directory where BINDIR, DOCDIR, MANDIR, and
32 SYSCONFDIR are located by default.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
33
08467bc @JNeitzel
authored
34 BINDIR Defaults to $(PREFIX)/bin. This is the target
35 directory where the binaries are installed.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
36
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
37 DOCDIR Defaults to $(PREFIX)/share/doc/$(OSH_VERSION).
38 This is the target directory for the [ACILNPR]*
39 package documentation and examples/* files.
40
41 MANDIR Defaults to $(PREFIX)/share/man/man1. This is
42 the target directory where the manual pages are
08467bc @JNeitzel
authored
43 installed.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
44
08467bc @JNeitzel
authored
45 SYSCONFDIR Defaults to $(PREFIX)/etc. This is the target
46 directory where the shell shall search for its
220aa37 @JNeitzel Update README and INSTALL for the next release, osh-20080629.
authored
47 system-wide rc (init and logout) files if such
48 files are available on the system. See also:
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
49
3b3ac09 @JNeitzel Replace instances of "www.v6shell.org" w/ "v6shell.org".
authored
50 http://v6shell.org/rc_files/
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
51
08467bc @JNeitzel
authored
52 ...
220aa37 @JNeitzel Update README and INSTALL for the next release, osh-20080629.
authored
53 for example rc files.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
54
08467bc @JNeitzel
authored
55 INSTALL Defaults to /usr/bin/install. The install(1)
56 utility is used to copy the resulting binaries
57 and manual pages to their final targets.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
58
08467bc @JNeitzel
authored
59 Mac OS X only:
9837254 @JNeitzel In INSTALL and Makefile, just use MOXARCH instead of MOXSHELLARCH
authored
60 The following configuration variable specifies the desired target
08467bc @JNeitzel
authored
61 architecture(s) for compiling universal binaries and/or 64-bit
5687bed @JNeitzel Update the [A-Z]* files as needed. Update to "osh-current (20081024)"
authored
62 binaries and/or 32-bit binaries for Mac OS X running on Intel
63 and PowerPC Macs.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
64
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
65 MOXARCH Unset by default. Possible value(s) may include
66 one or more of the following on supported systems:
67 -arch x86_64, -arch ppc64, -arch i386, -arch ppc.
08467bc @JNeitzel
authored
68 See also EXAMPLES.
69
70 -------
71 TARGETS
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
72 The following targets are available.
73
08467bc @JNeitzel
authored
74 all Default target is the same as typing `make'.
75 Compiles everything.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
76
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
77 install Installs all binaries, package documentation,
78 examples, and manual pages.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
79
5687bed @JNeitzel Update the [A-Z]* files as needed. Update to "osh-current (20081024)"
authored
80 oshall Compiles osh and generates manual pages.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
81
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
82 install-oshall Installs osh binary, package documentation,
83 examples, and manual pages.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
84
5687bed @JNeitzel Update the [A-Z]* files as needed. Update to "osh-current (20081024)"
authored
85 sh6all Compiles sh6, glob6, if, goto, fd2 and
86 generates manual pages.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
87
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
88 install-sh6all Installs sh6all binaries, package documentation,
89 and manual pages.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
90
08467bc @JNeitzel
authored
91 clean-obj Removes all object files.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
92
795b5d5 @JNeitzel
authored
93 clean Removes all binaries, object files, and other
94 files generated during the build.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
95
08467bc @JNeitzel
authored
96 --------
97 EXAMPLES
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
98 The following example compiles osh for /opt/local. It then installs
99 the osh binary into /opt/local/bin, package documentation and
100 examples into /opt/local/share/doc/$(OSH_VERSION), manual pages
101 into /opt/local/share/man/man1, and also sets SYSCONFDIR to
102 /opt/local/etc.
08467bc @JNeitzel
authored
103
104 % make PREFIX=/opt/local oshall
105 # make PREFIX=/opt/local install-oshall
106
107 The following example compiles sh6, glob6, if, goto, and fd2 for
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
108 /usr/pkg. It then installs these binaries into /usr/pkg/bin, package
109 documentation into /usr/pkg/share/doc/$(OSH_VERSION), and manual
110 pages into /usr/pkg/share/man/man1.
08467bc @JNeitzel
authored
111
112 % make PREFIX=/usr/pkg sh6all
113 # make PREFIX=/usr/pkg install-sh6all
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
114
21cc140 @JNeitzel Sync the INSTALL file w/ the Makefile as needed.
authored
115 The following example compiles everything, configuring the shell
116 to search for its system-wide rc files in /etc instead of /usr/local/etc
117 by default. It then installs the entire osh package into the default
118 location.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
119
120 % make SYSCONFDIR=/etc
121 # make install
122
123 The following example compiles each program as a 2-way 32-bit
08467bc @JNeitzel
authored
124 universal binary for Mac OS X running on Intel and PowerPC Macs.
125 It then installs the entire osh package into the default location.
7542a84 @JNeitzel Add a new file, INSTALL, which contains build and install instructions.
authored
126
127 % make MOXARCH='-arch i386 -arch ppc'
128 # make install
129
dcb944a @JNeitzel Add OpenSolaris note to README & OpenSolaris example to INSTALL.
authored
130 The following example shows what I do to compile and install the
131 osh package on OpenSolaris.
132
133 % uname -srvm
134 SunOS 5.11 snv_111b i86pc
135 % which cc gmake ginstall
136 /usr/gnu/bin/cc
137 /usr/bin/gmake
138 /usr/bin/ginstall
139 % gmake
140 # gmake INSTALL=/usr/bin/ginstall install
141
142 Jeffrey Allen Neitzel 2009/10/28
b180570 @JNeitzel Add ident.
authored
143
144 @(#)$Id$
Something went wrong with that request. Please try again.