Update the man pages. #839
Conversation
* Fix punctuation. * Fix spelling. * Update the date. * Update roff macros. * Update the wording for clarity. * Add missing command-line switch to one existing OPTIONS entry. * Add new command-line switches to the OPTIONS section. * Sort the entries in the OPTIONS section.
* Fix punctuation. * Fix spelling. * Update the date. * Update roff macros. * Update the wording for clarity. * Add missing command-line switch to one existing OPTIONS entry. * Add new command-line switches to the OPTIONS section. * Sort the entries in the OPTIONS section.
* Fix punctuation. * Fix spelling. * Update the date. * Update roff macros. * Update the wording for clarity. * Add missing command-line switch to one existing OPTIONS entry. * Sort the entries in the OPTIONS section.
* Fix, update, and add content to the **autokey-gtk.1** file. * Fix, update, and add content to the **autokey-qt.1** file. * Fix, update, and add content to the **autokey-run.1** file.
|
Hey there. All three man pages have been updated. You can preview the changes in the source code with the GitHub interface or, if you'd like to view the man pages as you would view any man page on your system, you can go to the doc/man directory on my fork (where the changed files currently are), and copy the contents of the files into files on your computer and then open the directory you put the files into and run the I've also zipped up the three original files, the three changed files, and a README.txt file listing the changes and providing viewing instructions and am attaching that zip file here in case you'd like to see them that way: |
|
Also, once this has been merged in, it will satisfy issue #682. |
|
doc/man/autokey-gtk.1 doc/man/autokey-gtk.1 30 Qt is independent of KDE. I don't think we do anything specific to KDE other than use Kdialog, so I'm not sure KDE should be explicitly mentioned here. I have no idea what it will do if --verbose is specified or if it is invoked while autokey-gtk is running. These are so far off the edge that I have never thought of them before. 60 I have never seen the --mouse switch before. When did that get added? How do you use it without making the log huge? |
This is in all three man pages and is because command-line is a compound adjective that was used before the noun it describes, so it requires a dash.
Good catch. I'll fix that momentarily and update this PR. I got the upper-case variant from the original files, but should have caught it, especially since I use Qt.
Since we use KDialog, it's fitting to mention KDE. I'll change the wording a bit momentarily to make it a little gentler.
Interesting. I hadn't realized that. I just tried it with autokey-gtk and autokey-qt and they both do that. I had no idea. It doesn't belong in the man page, though, but should definitely be added to the wiki.
Me, neither, but that isn't suggested in the man page, so it would only occur if someone happened to come up with the idea to try it on their own.
I'm not sure when it was added, but it's in the AutoKey 0.96.0 source code, so it's included here, because the purpose of this PR is to make the man pages current. I assume you would use it for debugging when you want to verify whether your mouse-clicks are registering and/or if they're occurring at the correct times and you probably wouldn't be running it that way for long. |
|
Should I remove "or at any time while the program is running" from the -c command-line switch description since it's not necessary to use that switch when AutoKey is already running? |
|
I supposed it wouldn't hurt to remove that, but since it works eitiher way, it's no big deal. |
|
I've removed it from the autokey-gtk.1 and autokey-qt.1 man pages and updated the dates on all three man pages to today. |
|
Good catch. Also, I think it should be "Open" instead of "Show" since "Show" would be used for displaying data in the terminal window in response to a command. The original wording is out, because it was: "Show the configuration window on startup, even if this is not the first run." That used "Show" and contradicted itself with the "on startup" part. I like your reduced version better as having the power of the "less is more" philosophy. I hadn't noticed the failed test either. Interesting. It says the operation was canceled. I have no idea what would cause it to be canceled, but can see why that would be marked as a failure. Let's see if the next test (which will happen shortly after I make the above change and update all the dates again) goes through fine. |
|
Okay, I've changed that line in the autokey-gtk.1 and autokey-qt.1 man pages to "Open the AutoKey main window." I've also updated the date in all three man pages. Last, but not least, I decided not to update the CHANGELOG.rst file because it already contains the entries from yesterday's changes, which are identical to the entries I would put in for today's changes and would just add duplicate entries. |
|
I got the information about the mouse command-line switches from the this section in the argument_parser.py file. I don't run AutoKey 0.96.0, so I haven't tested it. From its description, I take it that it will give you the usual verbose logging and then also note any detected mouse events as part of the output. I did improve line 44. Is that not showing for you? Here are the diffs for the most recent commits, with the text highlighted in green being my most recent edits: I got to those by clicking the commit comments in the most recent list of commits just above these three messages. You can also see their current state in the develop branch on my fork since that's where I made the changes and where this pull request is coming from. I also highly recommend copying the contents of each one into a text file (foo.txt in this example) and then viewing it as an actual man page with |
There was a problem hiding this comment.
I'm looking at this one 7897289 which shows a partial correction. No idea why we're looking at different things. Maybe my browser is caching pages? The commit hash doesn't match the one in your link.
Oops! there was another set of commits lower in this thread that I didn't see.
I'm looking again.
|
Yep, you got it. The originals never change and every new commit gets added inline below. They probably should have had it all congregating at the top of the page, instead, with perhaps some labels to identify what came first and what's new. That might be a good suggestion to make to GitHub. |
Fix, update, and add content to the autokey-gtk.1, autokey-qt.1, and autokey-run.1 files to make all three man pages current.