diff --git a/doc/dg-shell-plugin.pod.in b/doc/dg-shell-plugin.pod.in index 1c09563f6d87775f82507468fa14b7fdfd44b308..d11280be147c26f4f283ada052f359989cb66bc9 100644 --- a/doc/dg-shell-plugin.pod.in +++ b/doc/dg-shell-plugin.pod.in @@ -21,6 +21,7 @@ see the list of all contributors. =head1 SEE ALSO + dg-shell(1) See also <@PROJECT_URL@> for additional resources. diff --git a/doc/dg-shell.pod.in b/doc/dg-shell.pod.in index 28341a7f56c15f738aa874c706378a1f5c95a027..0654bbed0342c21180939828080e56339e9fe1ae 100644 --- a/doc/dg-shell.pod.in +++ b/doc/dg-shell.pod.in @@ -5,7 +5,7 @@ dg-shell - Stack of tasks shell =head1 SYNOPSIS -dg-shell [FILE] +dg-shell [--input <file>|-i <file>|--noninteractive|-n|--prologue|-prologue <file>|-h|--help] =head1 DESCRIPTION @@ -13,8 +13,40 @@ dg-shell [FILE] Start the stack of tasks and provides to the user an interactive shell to control the data-flow. -Optionally, a file which will be interpreted at start-up can be given -to the program. +By default, the shell first evaluates the prologue file +($HOME/.dg-shellrc by default). Additional input files passed as +arguments to evaluate multiple files. + + +=head1 OPTIONS + +B<-i> I<file>, B<--input> I<file> + evaluate the file at start-up + +B<-n>, B<--noninteractive> + enable the non-interactive mode + +B<-p> I<file>, B<--prologue> I<file> + override the default prologue file (i.e. $HOME/.dg-shellrc) + +B<-h>, B<--help> + produce help message + + +=head1 EXAMPLES + +No options is required to launch a shell: + + dg-shell + + +To evaluate "example.dg" only: + + dg-shell -i example.dg -n + +To evaluate "example1.dg", "example2.dg" and provide a shell to the user: + + dg-shell -i example1.dg -i example2.dg =head1 AUTHORS @@ -26,6 +58,7 @@ see the list of all contributors. =head1 SEE ALSO + dg-shell-plugin(1) See also <@PROJECT_URL@> for additional resources.