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

Add the autokey-shell man page. #870

Open
5 of 16 tasks
Elliria opened this issue Jun 3, 2023 · 3 comments
Open
5 of 16 tasks

Add the autokey-shell man page. #870

Elliria opened this issue Jun 3, 2023 · 3 comments
Assignees
Labels
bug documentation Documentation issues: Missing, wrong or outdated user documentation.

Comments

@Elliria
Copy link
Contributor

Elliria commented Jun 3, 2023

AutoKey is a Xorg application and will not function in a Wayland session. Do you use Xorg (X11) or Wayland?

Xorg

Has this issue already been reported?

  • I have searched through the existing issues.

Is this a question rather than an issue?

  • This is not a question.

What type of issue is this?

Documentation

Choose one or more terms that describe this issue:

  • autokey triggers
  • autokey-gtk
  • autokey-qt
  • beta
  • bug
  • critical
  • development
  • documentation
  • enhancement
  • installation/configuration
  • phrase expansion
  • scripting
  • technical debt
  • user interface

Other terms that describe this issue if not provided above:

No response

Which Linux distribution did you use?

No response

Which AutoKey GUI did you use?

None

Which AutoKey version did you use?

No response

How did you install AutoKey?

No response

Can you briefly describe the issue?

The autokey-shell man page is missing from the project and needs to be added.

Can the issue be reproduced?

Always

What are the steps to reproduce the issue?

Type man autokey-shell on the command-line.

What should have happened?

The man page should open.

What actually happened?

A message is displayed letting you know there is no such man page.

Do you have screenshots?

No response

Can you provide the output of the AutoKey command?

No response

Anything else?

The Running AutoKey scripts interactively on a shell section in the new_features.rst page gives a basic description of autokey-shell, which will help in creating the page.

Also, this search for autokey-run and this search for autokey-shell in AutoKey's code will prove useful in figuring out all the places that changes will need to be made to add a man page.

Last, but not least, when this is done, add links to this man page in the autokey-gtk and autokey-qt and autokey-run man pages.

@Elliria
Copy link
Contributor Author

Elliria commented Jun 3, 2023

This can be assigned to me, @josephj11, although I'll probably need help with making sure I've got it added correctly in all the right places when the time comes.

@josephj11
Copy link
Contributor

josephj11 commented Jun 4, 2023

The help comes from reqesting reviews ... Being assigned doesn't imply that you're on your own to get it done.

@josephj11 josephj11 added bug documentation Documentation issues: Missing, wrong or outdated user documentation. labels Jun 4, 2023
@Elliria
Copy link
Contributor Author

Elliria commented Jun 5, 2023

Yep. It was a heads-up that I'll likely need help, but you can assign it to me because I intend to get it done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Documentation issues: Missing, wrong or outdated user documentation.
Projects
None yet
Development

No branches or pull requests

2 participants