Appreciating grid engine 'man' pages

Posted by chris Thu, 22 Sep 2005 21:09:00 GMT

As is the case with many open source efforts, a rapid pace of development can often outpace the formal documentation efforts. This makes the SGE “man” pages critical resources for savvy users and administrators.

Why SGE man pages are so important

  • The man page entries are written by the developers who wrote the code

  • The man pages are maintained in the same CVS repository as the active gridengine codebase making updates, additions and corrections a simple matter.

  • Nobody really knows how to update the official documentation or when a tech writer will be hired to revise it. Check out the amazing list of open documentation issues to see this for yourself.

  • What this means is that although the formal documentation is of high quality it will certainly lag behind the man pages when it comes to documenting new features, fixes and behaviors.

Links to the most current Grid Engine manpages

The following list of man page links point directly to the current Grid Engine source repository.

Click on any of them to see the latest and greatest documentation for the manpage in question.

Section 1
gethostbyaddr   gethostbyname   gethostname   getservbyname   hostnameutils   qacct   qalter   qconf   qdel   qhold   qhost   qlogin   qmake   qmod   qmon   qping   qresub   qrls   qrsh   qselect   qsh   qstat   qsub   qtcsh   sge_ckpt   sge_intro   sge_types   sgepasswd   submit  

Section 3
drmaa_allocate_job_template   drmaa_attributes   drmaa_control   drmaa_delete_job_template   drmaa_exit   drmaa_get_DRM_system   drmaa_get_attribute   drmaa_get_attribute_names   drmaa_get_contact   drmaa_get_next_attr_name   drmaa_get_next_attr_value   drmaa_get_next_job_id   drmaa_get_vector_attribute   drmaa_get_vector_attribute_names   drmaa_init   drmaa_job_ps   drmaa_jobcontrol   drmaa_jobtemplate   drmaa_misc   drmaa_release_attr_names   drmaa_release_attr_values   drmaa_release_job_ids   drmaa_run_bulk_jobs   drmaa_run_job   drmaa_session   drmaa_set_attribute   drmaa_set_vector_attribute   drmaa_strerror   drmaa_submit   drmaa_synchronize   drmaa_version   drmaa_wait   drmaa_wcoredump   drmaa_wexitstatus   drmaa_wifaborted   drmaa_wifexited   drmaa_wifsignaled   drmaa_wtermsig  

Section 5
access_list   accounting   bootstrap   calendar_conf   checkpoint   complex   host_aliases   host_conf   hostgroup   project   qtask   queue_conf   reporting   sched_conf   sge_aliases   sge_conf   sge_pe   sge_priority   sge_qstat   sge_request   sgepasswd   share_tree   user   usermapping   sge_execd   sge_qmaster   sge_schedd   sge_shadowd   sge_shepherd  
Trackbacks

Use the following link to trackback from your own site:
http://gridengine.info/trackbacks?article_id=appreciating-grid-engine-man-pages&day=22&month=09&year=2005