Skip to content

Commit 3e57acf

Browse files
committed
Fix intro example
1 parent 93c46ea commit 3e57acf

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed
Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,31 @@
1-
> help config
2-
Configuration management.
1+
> help path
2+
Explore and manipulate paths.
3+
4+
There are three ways to represent a path:
5+
6+
* As a path literal, e.g., '/home/viking/spam.txt'
7+
* As a structured path: a table with 'parent', 'stem', and 'extension' (and
8+
* 'prefix' on Windows) columns. This format is produced by the 'path parse'
9+
subcommand.
10+
* As an inner list of path parts, e.g., '[[ / home viking spam.txt ]]'.
11+
Splitting into parts is done by the `path split` command.
12+
13+
join' subcommand can be used to join the structured path or path parts back into
14+
the path literal.
315
416
Usage:
5-
> config <subcommand> {flags}
17+
> path
618
719
Subcommands:
8-
config get - Gets a value from the config
9-
config set - Sets a value in the config
10-
config set_into - Sets a value in the config
11-
config clear - clear the config
12-
config remove - Removes a value from the config
13-
config path - return the path to the config file
20+
path basename - Get the final component of a path
21+
path dirname - Get the parent directory of a path
22+
path exists - Check whether a path exists
23+
path expand - Try to expand a path to its absolute form
24+
path join - Join a structured path or a list of path parts.
25+
path parse - Convert a path into structured data.
26+
path relative-to - Get a path as relative to another path.
27+
path split - Split a path into parts by a separator.
28+
path type - Get the type of the object a path refers to (e.g., file, dir, symlink)
1429
1530
Flags:
16-
-h, --help: Display this help message
31+
-h, --help

0 commit comments

Comments
 (0)