Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update to include the structure output of each command #98

Open
gnud opened this issue Jun 4, 2024 · 0 comments
Open
Assignees
Labels
feature New feature or request

Comments

@gnud
Copy link

gnud commented Jun 4, 2024

Is your feature request related to a problem? Please describe.
I'd like a clear picture of what command will render in the file, and how to prepare my /etc/hosts file before installing this tool (if needed).

Describe the solution you'd like
An update of the documentation description each of the operations what they will render, like 'add', 'remove', 'enable/disable profile'

Describe alternatives you've considered
For example, a table in the Readme showing each of the commands and what will render in the file.
What's the target audience: people who don't have time to read the instructions for the add command and don't know how to prepare the hosts file correctly in order to work with this tool.

Additional context

Examples:

hostctl --ip localhost add domains myprofile bla.com

will render:

# profile.on myprofile
localhost bla.com
# end

hosts enable myprofile

will render:

# profile.on myprofile
# data here for each hosts entry
# end

hosts disable myprofile

will render:

# profile.off myprofile
# data here for each hosts entry
# end

hosts remove myprofile

will remove the structure of the file.

This way without making backups users will be confident on the output that will rendered.

@gnud gnud added the feature New feature or request label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants