You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

98 lines
3.1 KiB

  1. .\" Hey, EMACS: -*- nroff -*-
  2. .\" (C) Copyright 2018 Marco Herrn <marco@mherrn.de>,
  3. .\"
  4. .\" First parameter, NAME, should be all caps
  5. .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
  6. .\" other parameters are allowed: see man(7), man(1)
  7. .TH Neo-layout-viewer 1 "December 19 2018"
  8. .\" Please adjust this date whenever revising the manpage.
  9. .\"
  10. .\" Some roff macros, for reference:
  11. .\" .nh disable hyphenation
  12. .\" .hy enable hyphenation
  13. .\" .ad l left justify
  14. .\" .ad b justify to both left and right margins
  15. .\" .nf disable filling
  16. .\" .fi enable filling
  17. .\" .br insert line break
  18. .\" .sp <n> insert n+1 empty lines
  19. .\" for manpage-specific macros, see man(7)
  20. .SH NAME
  21. neo-layout-viewer \- keyboard layout viewer for Neo 2
  22. .SH SYNOPSIS
  23. .B neo-layout-viewer
  24. .SH DESCRIPTION
  25. This manual page documents briefly the
  26. .B neo-layout-viewer
  27. commands.
  28. .B NeoLayoutViewer
  29. provides an easy way to display the
  30. .B NEO 2
  31. keyboard layout on screen.
  32. .PP
  33. The application window is an image of one of the six levels of the
  34. .B Neo 2
  35. keyboard layout. If one of the Mod-keys (Shift, …) is pressed or released
  36. the display switches to the corresponding level.
  37. .PP
  38. The application window can be hidden and moved via keyboard shortcuts. All
  39. settings can be modified via config file.
  40. .PP
  41. .SH OPTIONS
  42. .B neo-layout-viewer
  43. doesn't support any command line options.
  44. .SH KEYBINDINGS
  45. NeoLayoutViewer supports two keyboard shortcuts:
  46. .TP
  47. .B <Ctrl><Alt>q
  48. Hide/Show the application window
  49. .TP
  50. .B <Ctrl><Alt>n
  51. Move the application window around. This cycles the position of the
  52. application window between 8 different positions (each screen corner
  53. and centered on the screen edges.).
  54. The used positions can be reduced, see below.
  55. .PP
  56. Both shortcuts can be adapted by modifying the
  57. .B config file
  58. (see below).
  59. .SH CONFIGURATION
  60. The single configuration file is located in
  61. ~/.config/neo_layout_viewer.conf. This file is created on the first start
  62. of the application.
  63. .PP
  64. The config entries in the generated file are commented to identify the
  65. meaning of those options. The most important ones are:
  66. .TP
  67. .B width
  68. The exact width of the application window. To avoid unexpected behavior on
  69. on other resolutions, the width argument is ignored if it exceeds the range
  70. [screen_width * min_width, screen_width * min_width]
  71. .TP
  72. .B max_width, min_width
  73. This relative values limits the application window size.
  74. As example, max_with = 0.5 restricts the size on 50% of the screen width.
  75. The height can't be restricted directly.
  76. .TP
  77. .B display_function_keys
  78. Whether to display the function key row
  79. .TP
  80. .B display_numpad
  81. Whether to display the numpad block
  82. .TP
  83. .B show_shortcut
  84. The keyboard shortcut to hide/display the application window
  85. .TP
  86. .B move_shortcut
  87. The keyboard shortcut to move the window around. To remove the shortcut
  88. just leave it empty.
  89. .SH SEE ALSO
  90. .TP
  91. .I http://neo-layout.org/
  92. The official homepage of the Neo 2 keyboard layout.
  93. .\" .BR bar (1),
  94. .\" .BR baz (1).
  95. .\" .br
  96. .\" The programs are documented fully by
  97. .\" .IR "The Rise and Fall of a Fooish Bar" ,
  98. .\" available via the Info system.