Sun Grid Engine Intro Man File

From Biowiki
Jump to: navigation, search

(back to How To Use Sun Grid Engine)

This is, verbatim, the text of the man file for sge_intro, from the installation on sheridan. It's a good summary of the SGE command-line commands available to you.

I hope I have not violated any legalities in copying this here.

---

SGE_INTRO(1)				  Grid Engine User Commands				  SGE_INTRO(1)

NAME
		 Grid Engine - a facility for executing UNIX jobs on remote machines

DESCRIPTION
		 Grid  Engine  is  a  facility  for  executing  UNIX  batch jobs (shell
		 scripts) on a pool of cooperating workstations. Jobs  are  queued  and
		 executed  remotely  on  workstations  at times when those workstations
		 would otherwise be idle or only lightly loaded. The work load is  dis-
		 tributed  among  the  workstations in the cluster corresponding to the
		 load situation of each machine and the resource  requirements  of  the
		 jobs.

		 User  level  checkpointing  programs  are  supported and a transparent
		 checkpointing mechanism is provided (see sge_ckpt(1)).	Checkpointing
		 jobs migrate from workstation to workstation without user intervention
		 on load demand. In addition to batch jobs, interactive jobs and paral-
		 lel jobs can also be submitted to Grid Engine.

USER INTERFACE
		 The  Grid Engine user interface consists of several programs which are
		 described separately.

		 qacct(1)
				  qacct extracts arbitrary accounting information from the  clus-
				  ter logfile.

		 qalter(1)
				  qalter changes the characteristics of already submitted jobs.

		 qconf(1)
				  qconf  provides  the user interface for configuring, modifying,
				  deleting and querying queues and the cluster configuration.

		 qdel(1)
				  qdel provides the means for a user/operator/manager  to  cancel
				  jobs.

		 qhold(1)
				  qhold holds back submitted jobs from execution.

		 qhost(1)
				  qhost  displays  status information about Grid Engine execution
				  hosts.

		 qlogin(1)
				  qlogin initiates a telnet or similar login session  with  auto-
				  matic selection of a low loaded and suitable host.

		 qmake(1)
				  qmake  is a replacement for the standard Unix make facility. It
				  extends make by its  ability  to  distribute  independent  make
				  steps across a cluster of suitable machines.

		 qmod(1)
				  qmod  allows  the owner(s) of a queue to suspend and enable all
				  queues associated with his machine (all currently  active  pro-
				  cesses  in  this  queue  are  also  signaled) or to suspend and
				  enable jobs executing in the owned queues.

		 qmon(1)
				  qmon provides a Motif command  interface  to  all  Grid  Engine
				  functions.  The  status  of  all  or a private selection of the
				  configured queues is displayed on-line by  changing  colors  at
				  corresponding queue icons.

		 qresub(1)
				  qresub creates new jobs by copying currently running or pending
				  jobs.

		 qrls(1)
				  qrls releases holds from jobs previously assigned to them  e.g.
				  via qhold(1) (see above).

		 qrsh(1)
				  qrsh  can be used for various purposes such as providing remote
				  execution of interactive applications via Grid Engine  compara-
				  ble to the standard Unix facility rsh, to allow for the submis-
				  sion of batch jobs which, upon execution, support terminal  I/O
				  (standard/error  output  and  standard input) and terminal con-
				  trol, to provide a batch job submission  client  which  remains
				  active  until  the  job  has  finished or to allow for the Grid
				  Engine-controlled remote execution of  the  tasks  of  parallel
				  jobs.

		 qselect(1)
				  qselect prints a list of queue names corresponding to specified
				  selection criteria. The output of qselect is usually  fed  into
				  other  Grid  Engine commands to apply actions on a selected set
				  of queues.

		 qsh(1) qsh opens an interactive shell (in an xterm(1)) on a low loaded
				  host. Any kind of interactive jobs can be run in this shell.

		 qstat(1)
				  qstat  provides a status listing of all jobs and queues associ-
				  ated with the cluster.

		 qtcsh(1)
				  qtcsh is a fully compatible replacement for  the  widely  known
				  and used Unix C-Shell (csh) derivative tcsh. It provides a com-
				  mand-shell with the  extension  of  transparently  distributing
				  execution  of  designated  applications to suitable and lightly
				  loaded hosts via Grid Engine.

		 qsub(1)
				  qsub is the user interface for submitting a job to Grid Engine.

SEE ALSO
		 sge_ckpt(1),	qacct(1),	qalter(1),	qconf(1),  qdel(1),  qhold(1),
		 qhost(1), qlogin(1), qmake(1), qmod(1), qmon(1),  qresub(1),  qrls(1),
		 qrsh(1),  qselect(1), qsh(1), qstat(1), qsub(1), qtcsh(1), Grid Engine
		 Installation and Administration Guide, Grid Engine Quick Start  Guide,
		 Grid Engine User’s Guide.

COPYRIGHT
		 Copyright: 2004 by Sun Microsystems, Inc.

GE 6.0							  2004/05/26 17:37:54					  SGE_INTRO(1)

---

-- Andrew Uzilov - 28 Apr 2006