Une aide en ligne dédiée à l’utilisation d’Osaka, synthétisant un volume important de documentations et d’astuces, est disponible depuis une session sur Osaka grace à la commande h (pour help). Cette commande est un raccourci du module chargé par défaut **osaka_help**.Taper h dans le terminal renvoie une aide résumant les différents arguments et options acceptées :

>> h

osaka_help : Aide intégrée pour les utilisateurs d'Osaka

Utilisation : h [arg] [opts]

OPTIONS -----------------------------------------
    --fr        affichage en langue française (défaut)
    --en        english langage display
    -v          activer le mode "verbose" (bavard) : affiche la version
                détaillée des différents contenus
    -p          activer le mode "pager" : affiche  les contenus dans un 
                paginateur (less)

ARGUMENTS ---------------------------------------
    intro       introduction à l'utilsation du serveur de calcul Osaka
    doc         liens vers des documentations utilisateurs

    Informations sur le serveur de calcul
    hardware    informations sur les ressources physiques
    global      résumé du status du calculateur
    status      graphique résumant le status des ressources et des jobs
    jobs        affiche les jobs en queue et en exécution
    free        résumé des ressources de calcul actuellement disponibles

    Utilisation du serveur de calcul
    linux       guide de survie sous GNU-linux
    module      comment charger des logiciels sur votre environnement
    batch       comment lancer un job de calcul grace au systeme de batch
    script      exemples de scripts de soumission de job
    compiler    guide d'utilisation des compilateurs

    Divers
    log         journal des modifications d'Osaka
    git         introduction à la gestion de version
    remind      pense-bête des commandes utiles

RACCOURCIS --------------------------------------
    h           mode standard (équivalent à 'osaka_help')
    hh          mode bavard paginé (équivalent à 'h -v -p')
    he          english mode (same as 'h --en')
    hhe         verbose english mode with pager (same as 'hh --en -p')

Les arguments sont tous des thématiques qui, une fois tapés après la commande h, vont renvoyer d’autres menus thématiques ou des messages de documentation. Par exemple, la commande h linux affiche un résumé des commandes linux les plus utiles.

Osaka_help dispose de deux principales options :

--en

on en langue anglaise de chaque section thématique. Il est possible d’utiliser la version anglaise d’soaka_help sans utiliser cette option en utilisant le raccourcis he.

-v

Affiche la version « bavarde » de chaque section thématique. La documentation de osaka_help est pensée pour être lue une première fois en mode bavard, puis être consultée quotidiennement en mode normal. L’idée est de regrouper les explications complètes et les exemples dans le mode bavard, tandis que le mode standard est prévu pour être utilisé comme un aide mémoire. En cas de doute, pensez à utiliser le mode bavard. Il est possible d’utiliser le mode bavard sans utiliser cette option en utilisant le raccourci hh (ou le raccourci hhe pour la version anglaise).