cdown / clipmenu

Clipboard management using dmenu
MIT License
1.13k stars 90 forks source link

document options for clipmenu #121

Closed markstos closed 4 years ago

markstos commented 4 years ago

For privacy considerations, it's important to know about CM_MAX_CLIPS and it's default to storing to 1000 clipboard items by default.

Users could also use a hint about how to cleanly override environment variables with systemd.

cdown commented 4 years ago

Hmm, I've added a note recently about clipmenud --help, but I'd rather not duplicate systemd documentation here, and I'd rather keep the readme shorter if possible. Could you go over more about the rationale to add this here as opposed to just pointing to --help?

markstos commented 4 years ago

Each of these options is essentially a feature of clipmenu.

The ability to limit your history is particularly important feature for privacy.

A normal thing prospective users want to do when they are shopping for potential software to use is to be able to read a summary of the features offered to know whether they should even bother trying to install the software.

Put another way: Why pointing to the online help is OK for existing users to find the documentation, it's valuable for potential users to find this documentation without first installing the software.

Personally, a "max clips" feature is a key criteria on my shopping list for a clipboard manager. I imagine the other options exist because they are important to someone else who was shopping for a clipboard manager.

cdown commented 4 years ago

A normal thing prospective users want to do when they are shopping for potential software to use is to be able to read a summary of the features offered to know whether they should even bother trying to install the software.

Sure, then feel free to list some of the important features in a terse way, but we should just point to clipmenud --help to show the actual options -- let's avoid splitting sources of truth on documentation :-)

markstos commented 4 years ago

I've now simplified the options docs and re-framed them as a terse description of "features".

cdown commented 4 years ago

lgtm, thanks :-)