Changeset 29

Timestamp:

Nov 30, 2011, 10:42:49 PM (13 years ago)

Author:

g7moreau

Message:

• Manual for oar-envsh

Location:

trunk/oar

Files:

• Makefile (modified) (2 diffs)
• oar-envsh (modified) (1 diff)

trunk/oar/Makefile

@@ -7 +7 @@
 .PHONY: all clean distclean
 
-all: mpilauncher mpilauncher.1
+all: mpilauncher mpilauncher.1 oar-envsh.1
 
 clean:
@@ -23 +23 @@
 
 %.1: %.cpp
-        grep '^.\*' $< | sed -e 's/^..//; s/^.//' | pod2man -n $* $(PODFLAG) > $@
+        sed -re 's#^[/ ]\* ?##; s#^// ?##' $< | pod2man -n $* $(PODFLAG) > $@
+
+%.1: %
+        pod2man -n $* $(PODFLAG) $< > $@
 
 # astyle --style=banner -s3 mpilauncher.cpp

trunk/oar/oar-envsh

@@ -28 +28 @@
 
 exec /opt/oar/current/bin/oarsh $HOST "$MYENV $@"
+
+exit
+
+################################################################
+
+Documentation in Perl POD format (man perlpod)
+
+=head1 NAME
+
+ oar-envsh - oarsh with env variable transmit
+
+=head1 SYNOPSIS
+
+ oar-envsh node command
+
+=head1 DESCRIPTION
+
+C<oar-envsh> need to be executed inside an OAR cluster.
+It's a simple wrapper around C<oarsh> command
+which is a wrapper around C<ssh> command!
+
+With C<oar-envsh>, almost all env variable are export
+in the new shell except the following:
+
+ USER TERM OAR* SGE_* LS_COLORS
+ ENV BASH_ENV HOSTNAME LOGNAME MAIL
+ MANPATH OMPI_MCA_plm_rsh_agent PWD
+ SHELL SSH_* SUDO_COMMAND= HOME DISPLAY
+ SHLVL
+
+Alway use C<oarsh>,
+only use C<oar-envsh> if really needed!
+
+
+=head1 SEE ALSO
+
+oarsh
+
+
+=head1 AUTHORS
+
+Written by :
+
+ Nicolas Capit, Grenoble - France
+ Patrick Begou - Gabriel Moreau, Grenoble - France
+
+
+=head1 LICENSE AND COPYRIGHT
+
+GPL version 2 or later
+
+Copyright (C) 2011 Patrick Begou / LEGI - CNRS UMR 5519 - France
+
+=cut