← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/man/man5/hostgroup.5

  • 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:
doc/man/man5/hostgroup.5
 
1
'\" t
 
2
.\"___INFO__MARK_BEGIN__
 
3
.\"
 
4
.\" Copyright: 2004 by Sun Microsystems, Inc.
 
5
.\"
 
6
.\"___INFO__MARK_END__
 
7
.\" 
 
8
.\"
 
9
.\"
 
10
.\" Some handy macro definitions [from Tom Christensen's man(1) manual page].
 
11
.\"
 
12
.de SB          \" small and bold
 
13
.if !"\\$1"" \\s-2\\fB\&\\$1\\s0\\fR\\$2 \\$3 \\$4 \\$5
 
14
..
 
15
.\"
 
16
.de T           \" switch to typewriter font
 
17
.ft CW          \" probably want CW if you don't have TA font
 
18
..
 
19
.\"
 
20
.de TY          \" put $1 in typewriter font
 
21
.if t .T
 
22
.if n ``\c
 
23
\\$1\c
 
24
.if t .ft P
 
25
.if n \&''\c
 
26
\\$2
 
27
..
 
28
.\"
 
29
.de M           \" man page reference
 
30
\\fI\\$1\\fR\\|(\\$2)\\$3
 
31
..
 
32
.TH HOSTGROUP 5 "$Date$" "xxRELxx" "xxQS_NAMExx File Formats"
 
33
.\"
 
34
.SH NAME
 
35
hostgroup \- host group entry file format
 
36
.\"
 
37
.SH DESCRIPTION
 
38
.PP
 
39
A host group entry is used to merge host names to groups.
 
40
Each  host  group  entry  file defines one group. Inside a
 
41
group definition file you can also reference to groups. These
 
42
groups are called subgroups. A subgroup is referenced by the
 
43
sign "@" as first character of the name.
 
44
.PP
 
45
A list of currently configured host group entries can be displayed 
 
46
via the
 
47
.M qconf 1
 
48
\fB\-shgrpl\fP option. The contents of each enlisted host group entry 
 
49
can be
 
50
shown via the \fB\-shgrp\fP switch. The output follows the
 
51
.I hostgroup
 
52
format description. New host group entries can be created and existing can be
 
53
modified via the \fB\-ahgrp\fP, \fB\-mhgrp\fP, \fB\-dhgrp\fP and 
 
54
\fB\-?attr\fP options to
 
55
.M qconf 1 .
 
56
.PP
 
57
Note, xxQS_NAMExx allows backslashes (\\) be used to escape newline
 
58
(\\newline) characters. The backslash and the newline are replaced with a
 
59
space (" ") character before any interpretation.
 
60
.\"
 
61
.\"
 
62
.SH FORMAT
 
63
A host group entry contains following parameters:
 
64
.SS "\fBgroup_name\fP"
 
65
The group_name defines the host group name. Host group names have to
 
66
begin with an '@' character as explained for \fIhostgroup_name\fP in
 
67
.M sge_types 5 .
 
68
.SS "\fBhostlist\fP"
 
69
The name of all hosts and host groups (see 
 
70
\fIhost_identifier\fP in 
 
71
.M sge_types 1 )
 
72
which are member of the group. As list separators white-spaces are 
 
73
supported only. Default value for this parameter is NONE.
 
74
.PP
 
75
Note, if the first character of the \fIhost_identifier\fP is an "@" sign the name 
 
76
is used to reference a 
 
77
.M hostgroup 5 
 
78
which is taken as sub group of this group. 
 
79
.\"
 
80
.\"
 
81
 
 
82
.SH EXAMPLE
 
83
This is a typical host group entry:
 
84
 
 
85
.PP
 
86
group_name @bigMachines
 
87
.PP
 
88
hostlist @solaris64 @solaris32 fangorn balrog
 
89
.PP
 
90
 
 
91
The entry will define a new host group called 
 
92
\fB@bigMachines\fP. In this host group are the host 
 
93
\fBfangorn\fP, \fBbalrog\fP and all members of the host groups 
 
94
\fB@solaris64\fP and \fB@solaris32\fP.
 
95
 
 
96
.\"
 
97
 
 
98
.SH "SEE ALSO"
 
99
.M xxqs_name_sxx__types 1 ,
 
100
.M qconf 1
 
101
.\"
 
102
.SH "COPYRIGHT"
 
103
See
 
104
.M xxqs_name_sxx_intro 1
 
105
for a full statement of rights and permissions.