review of man page #87
No reviewers
Labels
No Label
blocked
bug
build
documentation
duplicate
enhancement
finger
gemini
gopher
help wanted
http
in progress
invalid
local
needs-info
non-code
non-functional
non-urgent
question
release
rendering
suggestion
telnet
terminal
urgent
wontfix
No Milestone
2 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: sloum/bombadillo#87
Loading…
Reference in New Issue
No description provided.
Delete Branch "manreview"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Reviewed for #64
I left one comment. I think it makes sense and is correct. If you find that it is not feel free to merge in as is. Otherwise, I approve pending a change to the commented area (and feel free to merge in after that).
@ -210,3 +212,3 @@
.B
lynxmode
Will use lynx as a rendering engine for http/https requests if lynx is installed and fIopenhttpfP is set to fItruefP. Valid values are fItruefP and fIfalsefP.
Will use lynx as a rendering engine for http/https requests if lynx is installed and both fIopenhttpfP and fIterminalonlyfP are set to fItruefP. Valid values are fItruefP and fIfalsefP.
I do not believe this update to be correct. If
lynxmode
and 'openhttpare both set to true then lynx will be used regardless of whether
terminalonlyis set to true or not. This enables desktop users, like myself, that want to render in the client to do so more easily. To access open in browser features
lynxmodemust be false and
openhttpmust be true, and
terminalonly` must be false.I've amended the documentation based on your feedback. I'd appreciate it if you could double-check it, and merge if OK. I found it a bit tricky to document the different states of
terminalonly
andlynxmode
, but I think this now is both correct and conveys the use cases.I am starting to agree with what you wrote elsewhere: three settings is a confusing situation. Should we ditch
lynxmode
as an option and just haveterminalonly
for determining how to open http links?If a user tries to open an http link (assuming
openhttp
is true) withterminalonly
as true and lynx is not installed, we can set it up to give an error indicating that fact.That would leave things with this grid:
That leaves me wondering if
terminalonly
is still an accurate name.gui
,webgui
,guimode
,terminalmode
,terminal
.Or there is what you had recommended, I think...correct me if I'm wrong: That we switch it from a boolean and just have a config setting of
webmode
and have the following availablenone
,gui
,lynx
,raw
(I could likely make a quick and dirty raw mode that just retrieves the html and does no rendering, though that mode could get added after 2.0.0 if it were deemed useful).I know this is a lot to think through. I appreciate you going through the manpage and making the updates and I'm sorry for being wishy-washy on this subject.
That's all good, no worries from my part at all. It's fun to work these things out.
I was writing this documentation with the idea in mind that we would consider changes to the functionality beyond version 2.0.0. If we did that:
.bombadillo.ini
, like the 2.0.0 releasePerhaps we should rename this to "review of man page", merge it in as-is, then discuss the next steps in #86.
Awesome. I agree, lets rename this PR and merge it in (I'll do that now) and resume conversation on #86 . I do think it would be good to sort it before release of 2.0.0 to avoid just what you mention: major ini changes right after people newly adopt and use a system.
Final review of man pageto review of man pageAlso, I fixed that broken table in the comments above.