Browse Source

Merge pull request #1445 from trapexit/docs

Misc doc updates + add logo
pull/1447/head
trapexit 5 days ago
committed by GitHub
parent
commit
212681ddc5
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 17
      mkdocs/docs/config/options.md
  2. 10
      mkdocs/docs/faq/why_isnt_it_working.md
  3. BIN
      mkdocs/docs/logo.jpeg
  4. BIN
      mkdocs/docs/logo.png
  5. 9
      mkdocs/docs/project_comparisons.md
  6. 2
      mkdocs/mkdocs.yml

17
mkdocs/docs/config/options.md

@ -1,9 +1,18 @@
# Options # Options
These options are the same regardless of whether you use them with the
`mergerfs` commandline program, in fstab, or in a config file.
mergerfs has many options to control it many features. For the average
use case the options listed in the [quickstart](../quickstart.md) are
sufficient. Most options are related to operating system or filesystem
related concepts so having a [basic
background](../intro_to_filesystems.md) in such things is recommended
for more advanced configurations.
### types
These option names and values are the same regardless of whether you
use them with the `mergerfs` commandline program, in fstab, or in a
config file.
## types
- BOOL = 'true' | 'false' - BOOL = 'true' | 'false'
- INT = [MIN_INT,MAX_INT] - INT = [MIN_INT,MAX_INT]
@ -18,7 +27,7 @@ These options are the same regardless of whether you use them with the
- POLICY = mergerfs function [policy](functions_categories_policies.md) - POLICY = mergerfs function [policy](functions_categories_policies.md)
### mount options
## mount options
- **config**: Path to a config file. Same arguments as below in - **config**: Path to a config file. Same arguments as below in
key=val / ini style format. key=val / ini style format.

10
mkdocs/docs/faq/why_isnt_it_working.md

@ -247,3 +247,13 @@ Be sure to set
or use Linux kernel v6.6 or above. rtorrent and some other or use Linux kernel v6.6 or above. rtorrent and some other
applications use [mmap](http://linux.die.net/man/2/mmap) to read and applications use [mmap](http://linux.die.net/man/2/mmap) to read and
write to files and offer no fallback to traditional methods. write to files and offer no fallback to traditional methods.
## Why don't I see mergerfs options in mount command or /proc/mounts?
FUSE filesystems, such as mergerfs, are interpreting most of the
possible options rather than being given to the kernel where those
options in the `mount` command and /proc/mounts come from.
If you want to see the options of a running instance of mergerfs you
can use the [runtime interface](../runtime_interfaces.md).

BIN
mkdocs/docs/logo.jpeg

Before

Width: 460  |  Height: 460  |  Size: 41 KiB

BIN
mkdocs/docs/logo.png

After

Width: 1024  |  Height: 1024  |  Size: 325 KiB

9
mkdocs/docs/project_comparisons.md

@ -101,6 +101,15 @@ used those other technologies. Meaning you can't create a file greater
than 1TB on a pool of 2 1TB filesystems. than 1TB on a pool of 2 1TB filesystems.
## BTRFS Single Data Profile
[BTRFS'](https://btrfs.readthedocs.io) `single` data profile is
similar to RAID0 but BTRFS can more explicitly place data and metadata
on multiple devices. However, like RAID0 and similar technologies if a
single device fails you may lose all data in the pool. BTRFS does have
some abilities to recover data but this is not guaranteed.
## RAID5, RAID6 ## RAID5, RAID6
* [RAID5](https://en.wikipedia.org/wiki/Standard_RAID_levels#RAID_5) * [RAID5](https://en.wikipedia.org/wiki/Standard_RAID_levels#RAID_5)

2
mkdocs/mkdocs.yml

@ -7,7 +7,7 @@ edit_uri: edit/master/mkdocs/docs/
docs_dir: docs docs_dir: docs
theme: theme:
name: material name: material
logo: logo.jpeg
logo: logo.png
features: features:
- content.action.edit - content.action.edit
- content.action.view - content.action.view

Loading…
Cancel
Save