diff --git a/README.md b/README.md index 5374235..484cef6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ obtained from [here](https://lftp.yar.ru/). In order to minimize password inputs, the bwda sftp server can be configured in `~/.netrc` in the following way. -``` +```text ~/.netrc --- machine archive-sftp.lsdf.kit.edu @@ -22,7 +22,7 @@ The tools included in this package require further machine-specific configurations to determine the path on bwda automatically. This is done using the file `~/.bwda`. Here is an example configuration for the machine `os-login.lsdf.kit.edu`. -``` +```text ~/.bwda --- bwda_acc="xyz" @@ -39,7 +39,7 @@ and add the directory to your `$PATH`. Do not forget to setup `$HOME/.bwda`. ## Usage ### Interactive session -``` +```text Usage: bwda [-h] [path] Opens an interactive lftp session on bwDataArchive. path directory on LSDF, session will cd to the corresponding bwda directory @@ -47,7 +47,7 @@ Opens an interactive lftp session on bwDataArchive. ``` ### List directory content on bwda -``` +```text Usage: bwdals [opt] List the contents of the current directory on bwda. Options are directly passed to lftp's ls command with the following exceptions: @@ -55,7 +55,7 @@ Options are directly passed to lftp's ls command with the following exceptions: ``` ### Transfer files from bwda to LSDF (in parallel) -``` +```text Usage: bwdaget files files files to be downloaded -c | --channel N use N channels per file @@ -65,7 +65,7 @@ Usage: bwdaget files ``` ### Syncronize files from LSDF to bwda -``` +```text Usage: bwdasync [opt] [dir] dir path to local directory on LSDF --include-size-mismatch include files which mismatch in size to sync list