https://github.com/codezeilen/wat-pages

Documentation of names in unix file systems
https://github.com/codezeilen/wat-pages

console documentation help linux manual python python3 shell terminal

Last synced: 4 months ago
JSON representation

Documentation of names in unix file systems

• Host: GitHub
• URL: https://github.com/codezeilen/wat-pages
• Owner: codeZeilen
• License: mit
• Created: 2023-06-04T12:14:45.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-23T12:39:10.000Z (5 months ago)
• Last Synced: 2025-01-23T13:37:01.155Z (5 months ago)
• Topics: console, documentation, help, linux, manual, python, python3, shell, terminal
• Language: Python
• Homepage: https://github.com/codeZeilen/wat
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# wat pages

This is the collection of pages used in the [wat](https://github.com/codeZeilen/wat) CLI tool.

Currently, it only contains the pages on names in the filesystem (`fs-path-pages`). 

## Page Format

The pages are written in Markdown. Pages must have a header that contains at least the path field. 

```

---

license: root directory descriptions originally created by contributors to the Ubuntu documentation wiki and based on https://help.ubuntu.com/community/LinuxFilesystemTreeOverview.

path: /bin

---

/bin is a place for most commonly used terminal commands, like ls, mount, rm, etc.

```

Filesystem pages can have two header fields:

 - path (required):  The path the page describes. It can include single globs, e.g. `/home/*/.bashrc`. If you want the page to refer to a single name, simple use the name as the path, e.g. `.gitignore`.

 - license (optional): If the page content is not original, you can specify the license and source of the content.

The *filename* of a page corresponds to the path with asterisks replaced by the word `glob` and slashes replaced by dashes, except for the first slash, e.g. `/home/*/.bashrc` becomes `home-glob-.bashrc.md`.