Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/app/federating-your-data/origin/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -506,14 +506,14 @@ See [Logging in to the Origin's Admin Page](#logging-in-to-the-origins-admin-pag

This section documents additional arguments you can pass via the command line when serving Origins.

* **-h or --help**: Output documentation on the `serve` command and its arguments.
* **-m or --mode**: Set the mode for the Origin service ('posix'|'s3, default to 'posix').
* **-p or --port**: Set the port at which the Pelican admin website should be accessible.
* **--writeable**: A boolean value to allow or disable writing to the Origin (default is true).
* **-v**: A shortcut for configuring docker-style volume mounts/namespace prefixes for the Origin (POSIX only). For example, `-v /local/path:/federation/prefix` will bind a directory `/local/path` to the namespace prefix `/federation/prefix`. Use of configuration yaml is strongly preferred over this method because config passed with this flag cannot be picked up by tools like `pelican config summary`.
* **--config**: Set the location of the configuration file.
* **-d or --debug**: Enable debugging mode, which greatly increases the Pelican's logging verbosity
* **-l or --log**: Set the location of a file that will capture Pelican logs. Setting this will prevent logging output from printing to your terminal.
* **`-h` or `--help`**: Output documentation on the `serve` command and its arguments.
* **`-m` or `--mode`**: Set the mode for the Origin service ('posix'|'s3, default to 'posix').
* **`-p` or `--port`**: Set the port at which the Pelican admin website should be accessible.
* **`--writeable`**: A boolean value to allow or disable writing to the Origin (default is true).
* **`-v`**: A shortcut for configuring docker-style volume mounts/namespace prefixes for the Origin (POSIX only). For example, `-v /local/path:/federation/prefix` will bind a directory `/local/path` to the namespace prefix `/federation/prefix`. Use of configuration yaml is strongly preferred over this method because config passed with this flag cannot be picked up by tools like `pelican config summary`.
* **`--config`**: Set the location of the configuration file.
* **`-d` or `--debug`**: Enable debugging mode, which greatly increases the Pelican's logging verbosity
* **`-l` or `--log`**: Set the location of a file that will capture Pelican logs. Setting this will prevent logging output from printing to your terminal.

For more information about available yaml configuration options, refer to the [Parameters page](../parameters.mdx).

Expand Down
26 changes: 13 additions & 13 deletions docs/app/getting-data-with-pelican/client/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -224,22 +224,22 @@ The Pelican client supports a variety of command line flags that modify the clie

### Global Flags:

- **-h or --help:** Takes no argument and can be used with any Pelican sub command for more information about the sub command and additional supported flags.
- **-f or --federation:** Takes a URL that indicates to Pelican which federation the request should be made to.
- **-d or --debug:** Takes no argument, but runs Pelican in debug mode, which provides verbose output for debugging purposes.
- **--config:** Takes a filepath and indicates to Pelican the location of the Pelican configuration file.
- **--json:** Takes no argument and outputs results in JSON format.
- **-l or --log:** Takes a string that specifies a file location to output the pelican logs to rather than the stderr.
- **--version:** Prints the version of Pelican and exits.
- **`-h` or `--help`:** Takes no argument and can be used with any Pelican sub command for more information about the sub command and additional supported flags.
- **`-f` or `--federation`:** Takes a URL that indicates to Pelican which federation the request should be made to.
- **`-d` or `--debug`:** Takes no argument, but runs Pelican in debug mode, which provides verbose output for debugging purposes.
- **`--config`:** Takes a filepath and indicates to Pelican the location of the Pelican configuration file.
- **`--json`:** Takes no argument and outputs results in JSON format.
- **`-l` or `--log`:** Takes a string that specifies a file location to output the pelican logs to rather than the stderr.
- **`--version`:** Prints the version of Pelican and exits.

### Flags For `object get/put/copy`:

- **-c or --cache:** Takes a cache URL and indicates to Pelican that only the specified cache should be used. When used, Pelican will not attempt to use other caches if the provided cache cannot provide the file.
- **--caches:** Takes the path to a JSON file containing a list of caches. Similar to the `-c` flag, Pelican will attempt to use only these caches in the order they are listed.
- **-h or --help:** Gives additional information on how to use the command as well as lists these flags with short descriptions for the `object copy` command.
- **--methods:** Takes a comma separated list of methods to try for downloads/uploads, the default is just http.
- **-r or --recursive:** Takes no argument and indicates to Pelican that all sub paths at the level of the provided namespace should be copied recursively. This option is only supported if the origin supports the WebDav protocol.
- **-t or --token:** Takes a path to a file containing a signed JWT, and is used to download protected objects.
- **`-c` or `--cache`:** Takes a cache URL and indicates to Pelican that only the specified cache should be used. When used, Pelican will not attempt to use other caches if the provided cache cannot provide the file.
- **`--caches`:** Takes the path to a JSON file containing a list of caches. Similar to the `-c` flag, Pelican will attempt to use only these caches in the order they are listed.
- **`-h` or `--help`:** Gives additional information on how to use the command as well as lists these flags with short descriptions for the `object copy` command.
- **`--methods`:** Takes a comma separated list of methods to try for downloads/uploads, the default is just http.
- **`-r` or `--recursive`:** Takes no argument and indicates to Pelican that all sub paths at the level of the provided namespace should be copied recursively. This option is only supported if the origin supports the WebDav protocol.
- **`-t` or `--token`:** Takes a path to a file containing a signed JWT, and is used to download protected objects.

## Aliases of The Pelican Binary

Expand Down
10 changes: 5 additions & 5 deletions docs/app/operating-a-federation/cache/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ This will start a Pelican cache as a daemon process.

This section documents the additional arguments you can pass to the command above to run the cache.

* **-h or --help**: Output documentation on the `serve` command and its arguments.
* **-p or --port**: Set the port at which the Pelican admin website should be accessible.
* **`-h` or `--help`**: Output documentation on the `serve` command and its arguments.
* **`-p` or `--port`**: Set the port at which the Pelican admin website should be accessible.

* **--config**: Set the location of the configuration file.
* **-d or --debug**: Enable the debugging mode, allowing for more verbose log
* **-l or --log**: Set the location of the file where log messages should be redirected to and not output the the console.
* **`--config`**: Set the location of the configuration file.
* **`-d` or `--debug`**: Enable the debugging mode, allowing for more verbose log
* **`-l` or `--log`**: Set the location of the file where log messages should be redirected to and not output to the console.

There are other configurations available to modify via the configuration file. Refer to the [Parameters](../parameters.mdx) page for details.

Expand Down
Loading