sway.1.txt 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. /////
  2. vim:set ts=4 sw=4 tw=82 noet:
  3. /////
  4. sway (1)
  5. ========
  6. Name
  7. ----
  8. sway - SirCmpwn's Wayland window manager
  9. Synopsis
  10. --------
  11. 'sway' [options] [command]
  12. Options
  13. -------
  14. *-c, \--config* <config>::
  15. Specifies a config file.
  16. *-C, \--validate*::
  17. Check the validity of the config file, then exit.
  18. *-d, --debug*::
  19. Enables full logging, including debug information.
  20. *-v, \--version*::
  21. Show the version number and quit.
  22. *-V, --verbose*::
  23. Enables more verbose logging.
  24. *--get-socketpath*::
  25. Gets the IPC socket path and prints it, then exits.
  26. Description
  27. -----------
  28. sway was created to fill the need of an i3-like window manager for Wayland. The
  29. upstream i3 developers have no intention of porting i3 to Wayland, and projects
  30. proposed by others ended up as vaporware. Many thanks to the i3 folks for
  31. providing such a great piece of software, so good that your users would rather
  32. write an entirely new window manager from scratch that behaved _exactly_ like i3
  33. rather than switch to something else.
  34. You may run sway from an ongoing x11 session to run it within x. Otherwise, you
  35. can run sway on a tty and it will use your outputs directly.
  36. *Important note for nvidia users*: The proprietary nvidia driver does _not_ have
  37. support for Wayland as of 2015-08-17. Use nouveau.
  38. Commands
  39. --------
  40. If sway is currently running, you may run _sway [command]_ to send _command_ to
  41. the running instance of sway. The same commands you would use in the config file
  42. are valid here (see **sway**(5)). For compatability reasons, you may also issue
  43. commands with **sway-msg**(1) or **i3-msg**(1) (or even with **i3**(1), probably).
  44. Configuration
  45. -------------
  46. If _-c_ is not specified, sway will look in several locations for your config
  47. file. The default one is provided at /etc/sway/config. The suggested location for
  48. your config file is ~/.config/sway/config. ~/.sway/config will also work, and the
  49. rest of the usual XDG config locations are supported. If no sway config is found,
  50. sway will attempt to load an i3 config from all the config locations i3 supports.
  51. If still nothing is found, you will receive an error.
  52. For information on the config file format, see **sway**(5).
  53. Authors
  54. -------
  55. Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
  56. source contributors. For more information about sway development, see
  57. <https://github.com/SirCmpwn/sway>.
  58. See Also
  59. --------
  60. **sway**(5)