Comments (3)
tyhicks
commented on May 5, 2024
2
On 07/13/2017 04:03 AM, Joseph Richey wrote:
Is this <http://www.linuxhowtos.org/System/creatingman.htm> a good place
to get started on writing a man page?
That's a fine place to start if one simply wants to write raw groff.
There's nothing wrong with that and it is probably the simplest solution.
There are tools that convert other formats, such as pod, Markdown, RST,
etc., into man pages but most of them seem to pull in too many unrelated
build dependencies (Perl for pod2man, Ruby for ronn, Python for rst2man)
for a Go/C project.
Also, the ecryptfs man pages are spread throughout many sections. The
root page is in section 7 <https://linux.die.net/man/7/ecryptfs> but
some components are in section 1
<https://linux.die.net/man/1/ecryptfs-add-passphrase> or section 8
<https://linux.die.net/man/8/pam_ecryptfs>. Should I just put everything
in section 8 or split things up accordingly?
The man page for the fscrypt tool should go into section 8. If you plan
to write additional man pages, it'll depend on what they're documenting.
The man(1) man page gives a decent summary of which sections should be used.
I wouldn't necessarily follow the lead of ecryptfs-utils man pages but
they're a fairly good reference.
from fscrypt.
josephlr
commented on May 5, 2024
Is this a good place to get started on writing a man page?
Also, the ecryptfs man pages are spread throughout many sections. The root page is in section 7 but some components are in section 1 or section 8. Should I just put everything in section 8 or split things up accordingly?
from fscrypt.
josephlr
commented on May 5, 2024
Below is the basic plan for man page entries. After they are completed, a good amount of the documentation in README.md will be deleted and replaced with the appropriate man page links. Running fscrypt COMMAND --help will also show the man pages (if they are available). This is similar to how git COMMAND --help works currently.
- fscryptctl
- Complete description of all functionality
- The tool is small so this shouldn't be too bad
- Include where to report bugs (here)
- fscrypt
- Overview of the tool
- Tool's purpose
- Structures of files (
/etc/fscrypt.conf,MNT/.fscrypt) - System requirements
- Filesystem requirements
- Limitations (no encrypting root, no encrypting metadata)
- Where to report bugs (here)
- Links to more detailed command information
- pam_fscrypt
- Description of purpose/functionality
- PAM services provided
- Flags (and which services they effect)
- Installation instructions/tips
- fscrypt-setup
- Docs for
fscrypt setup(creating/etc/fscrypt.conf) - Docs for
fscrypt setup MOUNTPOINT(creating filesystem metadata)
- Docs for
- fscrypt-encrypt
- Docs for
fscrypt encryptandfscrypt unlock - Notes about keyring weirdness w/ provisioning
- Docs for
- fscrypt-purge
- Docs for
fscrypt purge MOUNTPOINT - Explain dropping vs not dropping caches
- Limitations of running as root
- Issues w/ Kernel memory and DMA
- Docs for
- fscrypt-status
- Docs for
fscrypt status: the global, filesystem, and directory versions. - Precise format (so it can be reliably grepped)
- Difference between "supported", "not supported", and "not enabled"
- Docs for
- fscrypt-metadata
- Docs for all
fscrypt metadata SUBCOMMAND - Examples of weird setups requiring the metadata commands.
- Examples of damaged setups requiring the metadata commands.
- Docs for all
from fscrypt.
Related Issues (20)
- fscrypt master key handling at kernel space adding additional secure params. HOT 2
- In fscrypt user space, after removing the key from key ring, the encrypted directories file names continues to be in clear form. HOT 2
- Support for individual files to assigned instead of directory level HOT 3
- "fscrypt metadata add-protector-to-policy" doesn't work in key files HOT 1
- Poor scriptability due to --name not being easily checkable HOT 2
- failureExitCode should return higher number than 1 if user tries to lock an already locked file
- Deleting files from folder encrypted with fscrypt HOT 4
- Partial Decrypt HOT 3
- fscrypt tests fail on non x86_64 arches (aarch64, ppc64le, s390x) HOT 7
- How to resolve "Some processes can't access unlocked encrypted files"? HOT 2
- Should we make the fscrypt metadata harder to delete? HOT 2
- multiple login nodes (multiple lustre client), how should I correctly apply the fscrypt tool to encrypt files under shared storage? HOT 1
- Unlocking of encrypted directory inside of disk partition image does not work while fscrypt confirms "ready for use" HOT 4
- Generate `fscrypt.conf` with Adiantum as the encryption mode HOT 2
- How to unlock encrypted regular files located in an unencrypted directory? HOT 8
- Obscure error message due to process address space limit HOT 5
- A question: how does diectory know what policy protects it? HOT 12
- Is it good Idea to copy and reuse policy on other device? Is it good idea to copy and reuse a protector? HOT 2
- fscrypt on CephFS does not recognize locked directories upon remount HOT 7
- fscrypt on CephFS: no buffer space available HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from fscrypt.