~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to source/scripts/README.distinst

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
ImportĀ upstreamĀ versionĀ 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
                           README.distinst
 
2
                           ---------------
 
3
 
 
4
 
 
5
Content
 
6
-------
 
7
 
 
8
1) What 'distinst' is and what it does
 
9
2) Common command line options of 'distinst'
 
10
3) Copyright
 
11
 
 
12
 
 
13
1) What 'distinst' is
 
14
---------------------
 
15
 
 
16
   After compiling Grid Engine it can be staged for installation via
 
17
   'distinst'. The staging copies the files (binaries, manual pages,
 
18
   documentation, other files needed for installing and running Grid
 
19
   Engine) to a distribution directory.
 
20
 
 
21
   'distinst' has a couple of shortcuts to install parts of the
 
22
   distribution: all or selected binaries for one or more architectures and
 
23
   all or selected parts of architecture independent files.
 
24
 
 
25
   'distinst' has no built in dependencies on compile targets. You need to
 
26
   make sure that the targets you are installing are up-to-date.
 
27
 
 
28
   Typically there are two scenarios in which a distribution needs to be
 
29
   created. (1) During development changes should be tested as quickly as
 
30
   possible. (2) As soon as development is done, you may want to create a
 
31
   repository to create further distributions (in tar.gz format), e.g. for
 
32
   putting it on a FTP server. 'distinst' supports both types of staging. If
 
33
   the script is called as 'distinst', the files to stage will be copied to
 
34
   a repository, if the script is called as 'myinst', the files will be
 
35
   copied to the directory to which the environment variable $SGE_ROOT
 
36
   points.
 
37
 
 
38
   There is not much difference between both types. By default 'distinst'
 
39
   has a "strict" behavior - it will exit with an error message if one of
 
40
   the targets cannot be installed.
 
41
 
 
42
   You should create a symbolic link to distinst to have both versions
 
43
   available
 
44
 
 
45
      % ln -s scripts/distinst myinst
 
46
 
 
47
 
 
48
2) Common command line options of 'distinst'
 
49
--------------------------------------------
 
50
 
 
51
   Show a brief summary of its command line options:
 
52
 
 
53
      % distinst -help
 
54
 
 
55
   To install your very first distribution, e.g. on Solaris 64bit kernel and
 
56
   on Linux, you may want to begin as follows (see 'scripts/README.arch'
 
57
   about the architecture strings)
 
58
 
 
59
      % mkdir <sge_root_dir>
 
60
      % setenv SGE_ROOT <sge_root_dir>
 
61
 
 
62
      % ./myinst -allall solaris64 glinux
 
63
 
 
64
   You will probably see a lot of error messages (because man pages are not
 
65
   available or not all binaires have been created).
 
66
 
 
67
   'distinst' has the following command line syntax
 
68
 
 
69
      distinst [-opts] [archs] [ -- other progs]
 
70
 
 
71
 
 
72
   The following options are supported:
 
73
 
 
74
   -v           give more verbose output
 
75
 
 
76
   -allall      install really everything, architecture independent files
 
77
                manual pages, available documentation and binaries for
 
78
                selected architectures
 
79
 
 
80
   -all         like "-allall" but don't install man pages and available 
 
81
                documentation
 
82
 
 
83
   -bin         install only binaries for selected architectures
 
84
 
 
85
   -sgeee       install Enhanced Grid Engine distribution
 
86
                (formerly known as the Global Resource Director, GRD)  
 
87
 
 
88
   -basedir     define base directory for distribution (distinst)
 
89
 
 
90
   -versiondir  distribution will be installed in this direcotry below
 
91
                basedir (for distinst only)
 
92
                 
 
93
   -noinst      do nothing, just show the uppercase target architecture
 
94
                and default /\$BASEDIR/\$VERSIONDIR
 
95
 
 
96
   For "other targets", the name of the binaries are supported and a few
 
97
   special targets.
 
98
 
 
99
   Binary names are: sge_qmaster, sge_execd, qstat, qmon ....
 
100
 
 
101
   The special targets are:
 
102
 
 
103
   distcommon    arch. independent files, man pages, files going to doc/
 
104
   common        arch. independent files
 
105
   ckpt          checkpointing support files going to ckpt/
 
106
   doc           doc/ directory tree"
 
107
   examples      examples/ directory tree without binaries  
 
108
   inst_sge      the installation script
 
109
   jobs          example job binaries going to examples/jobsbin/
 
110
   man           manual pages in nroff and catman format
 
111
   pvm           PVM sample source files and scripts going to pvm/
 
112
   mpi           MPI scripts and README's going to mpi/
 
113
   qmontree      qmon pixmaps, resource-, help-, copyright files
 
114
   sec           DCE/Kerberos security modules (only if available)
 
115
   secbin        DCE/Kerberos security binaries (only if available)
 
116
   txtdoc        doc/ directory tree without PDF files
 
117
   utilbin       binaries going to the utilbin/ directory for selected
 
118
                 architectures
 
119
   utiltree      files going to the util/ directory hierarchy
 
120
 
 
121
 
 
122
   Examples:
 
123
   ---------
 
124
 
 
125
   Install all tru64 and Linux binaries:
 
126
 
 
127
      ./myinst -bin tru64 glinux      
 
128
 
 
129
   Install sge_qmaster for tru64 and solaris:
 
130
 
 
131
      ./myinst tru64 solaris -- sge_qmaster
 
132
   
 
133
   Install only architecture independ files
 
134
 
 
135
      ./myinst -allall
 
136
 
 
137
   Install only MPI and PVM directories
 
138
 
 
139
      ./myinst -mpi -pvm
 
140
 
 
141
 
 
142
3) Copyright
 
143
------------
 
144
 
 
145
   The Contents of this file are made available subject to the terms of
 
146
   the Sun Industry Standards Source License Version 1.2
 
147
 
 
148
   Sun Microsystems Inc., March, 2001
 
149
 
 
150
   Sun Industry Standards Source License Version 1.2  
 
151
   =================================================
 
152
   The contents of this file are subject to the Sun Industry Standards
 
153
   Source License Version 1.2 (the "License"); You may not use this file
 
154
   except in compliance with the License. You may obtain a copy of the
 
155
   License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
 
156
 
 
157
   Software provided under this License is provided on an "AS IS" basis,
 
158
   WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 
159
   WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,   
 
160
   MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 
161
   See the License for the specific provisions governing your rights and
 
162
   obligations concerning the Software.
 
163
 
 
164
   The Initial Developer of the Original Code is: Sun Microsystems, Inc.  
 
165
 
 
166
   Copyright: 2001 by Sun Microsystems, Inc.
 
167
 
 
168
   All Rights Reserved.