Skip to content

Clarify README output semantics #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
unitmatrix wants to merge 1 commit into from
Closed

Clarify README output semantics #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ zget -1 URL [MEMBER]

## Familiar by design

Archive operations follow `unzip` where practical, while output conventions
follow `curl`. `zget URL MEMBER` therefore streams to standard output, while
`-o FILE` names a local output. Unlike ordinary redirection, named output is
validated completely before publication and never overwrites an existing path.
`-l` requests an `unzip`-style listing; the compact `-1` form follows `zipinfo`
and emits only names.
Archive operations follow `unzip` where practical, while the output interface
follows `curl`: `zget URL MEMBER` streams to standard output, while `-o FILE`
selects a local path. zget deliberately differs from curl's overwrite behavior:
named output is validated completely before publication and never overwrites an
existing path. `-l` requests an `unzip`-style listing; the compact `-1` form
follows `zipinfo` and emits only names.

Extraction requires both a URL and an exact member name. A URL without a member
is a usage error rather than an implicit request to list the archive; use `-l`
Expand Down Expand Up @@ -332,10 +332,6 @@ redirects cannot downgrade to HTTP. A strong ETag from the first accepted
response is used for later `If-Match` requests. Without one, consistency is
best-effort and still checks the object size.

`-o` writes a temporary file in the destination directory and publishes it only
after decompression and CRC validation. Existing paths are never overwritten.
Stdout cannot be rolled back if a late error occurs.

## Scope

- Exact, case-sensitive full member paths; no normalization or globbing.
Expand Down