raft-format/README.md

33 lines
1.4 KiB
Markdown
Raw Normal View History

2024-01-18 17:24:09 +00:00
# zarf archive format
by [Charles Iliya Krempeaux](http://changelog.ca/)
The **zarf format** is an **archive format** and **container format** that can combine multiple files into a single aggregate file.
2024-01-18 17:39:07 +00:00
The **zarf format** is similar to other **archive formats**, such as the **ar format**, the **cpio format**, the **shar format**, the **tar format**, and the **WARC format** — but is designed to be easier to understand and implement than all of the other **archive formats** and **container formats**.
2024-01-18 17:24:09 +00:00
2024-01-18 17:39:07 +00:00
In fact, one of the main points of the **zarf format** existing, is that it was designed to be easy to understand and implement for programmers.
2024-01-18 19:05:05 +00:00
The **zarf format** is meant to be both programmer-legible and programmer-friendly.
2024-01-18 17:39:07 +00:00
## Extension
Although **zarf** does _not_ require an extension (since it has magic-bytes), if a file-extension is used for a **zarf** file, it should use the `.zarf` extension (on systems where file-extensions are necessary).
2024-01-18 19:06:42 +00:00
For example:
`stuff.zarf`
2024-01-18 17:39:07 +00:00
## MIME Type
Although **zarf** does _not_ require a MIME-type (since it has magic-bytes), f a MIME-type is used for a **zarf** file, it should use the `multipart/zarf` extension (on systems where file-extensions are necessary).
2024-01-18 19:06:42 +00:00
For example:
```
Content-Type: multipart/zarf
```
2024-01-18 17:39:07 +00:00
## Name
2024-01-18 17:24:09 +00:00
The name “zarf” has 2 meanings:
2024-01-18 17:40:28 +00:00
* it is an acronym “**Z**arf **AR**chive **F**ormat”, and
2024-01-18 17:24:09 +00:00
* it also happens to be the Persian word for container.