Changeset 29


Ignore:
Timestamp:
Nov 30, 2011, 10:42:49 PM (9 years ago)
Author:
g7moreau
Message:
  • Manual for oar-envsh
Location:
trunk/oar
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/oar/Makefile

    r24 r29  
    77.PHONY: all clean distclean
    88
    9 all: mpilauncher mpilauncher.1
     9all: mpilauncher mpilauncher.1 oar-envsh.1
    1010
    1111clean:
     
    2323
    2424%.1: %.cpp
    25         grep '^.\*' $< | sed -e 's/^..//; s/^.//' | pod2man -n $* $(PODFLAG) > $@
     25        sed -re 's#^[/ ]\* ?##; s#^// ?##' $< | pod2man -n $* $(PODFLAG) > $@
     26
     27%.1: %
     28        pod2man -n $* $(PODFLAG) $< > $@
    2629
    2730# astyle --style=banner -s3 mpilauncher.cpp
  • trunk/oar/oar-envsh

    r20 r29  
    2828
    2929exec /opt/oar/current/bin/oarsh $HOST "$MYENV $@"
     30
     31exit
     32
     33################################################################
     34
     35Documentation in Perl POD format (man perlpod)
     36
     37=head1 NAME
     38
     39 oar-envsh - oarsh with env variable transmit
     40
     41=head1 SYNOPSIS
     42
     43 oar-envsh node command
     44
     45=head1 DESCRIPTION
     46
     47C<oar-envsh> need to be executed inside an OAR cluster.
     48It's a simple wrapper around C<oarsh> command
     49which is a wrapper around C<ssh> command!
     50
     51With C<oar-envsh>, almost all env variable are export
     52in the new shell except the following:
     53
     54 USER TERM OAR* SGE_* LS_COLORS
     55 ENV BASH_ENV HOSTNAME LOGNAME MAIL
     56 MANPATH OMPI_MCA_plm_rsh_agent PWD
     57 SHELL SSH_* SUDO_COMMAND= HOME DISPLAY
     58 SHLVL
     59
     60Alway use C<oarsh>,
     61only use C<oar-envsh> if really needed!
     62
     63
     64=head1 SEE ALSO
     65
     66oarsh
     67
     68
     69=head1 AUTHORS
     70
     71Written by :
     72
     73 Nicolas Capit, Grenoble - France
     74 Patrick Begou - Gabriel Moreau, Grenoble - France
     75
     76
     77=head1 LICENSE AND COPYRIGHT
     78
     79GPL version 2 or later
     80
     81Copyright (C) 2011 Patrick Begou / LEGI - CNRS UMR 5519 - France
     82
     83=cut
Note: See TracChangeset for help on using the changeset viewer.