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
Port man pages to scdoc #1958
Port man pages to scdoc #1958
Conversation
sway/sway.1.scd
Outdated
- /etc/sway/config | ||
- /etc/i3/config | ||
|
||
If unset, $XDG\_CONFIG\_HOME defalts to *~/.config*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: defaults
We will need to overhaul this for 1.0
We'll have to rewrite this later.
This is ready for review. |
README.fr.md
Outdated
@@ -62,6 +61,7 @@ Installez les dépendances : | |||
* pam ** | |||
* imagemagick (requis pour la capture d'image avec swaygrab) | |||
* ffmpeg (requis pour la capture vidéo avec swaygrab) | |||
* [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (requis pour man pages) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds really weird. I'd say "requis pour les pages man".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried my best :')
sway/sway.5.scd
Outdated
arguments of future commands. | ||
|
||
*swaybg\_command* <command> | ||
Executes custom bg _command_. Default is _swaybg_. Refer to **output** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should say "background", it's not directly obvious what "bg" is
sway/sway.5.scd
Outdated
The available classes are: | ||
|
||
*client.background* | ||
Ignored (present for i3 compatability). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/compatability/compatibility/
sway/sway.5.scd
Outdated
The most recently focused view within a container which is not focused. | ||
|
||
*client.placeholder* | ||
Ignored (present for i3 compatability). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto
sway/sway.5.scd
Outdated
Executes _shell command_ with sh. | ||
|
||
*exec\_always* <shell command> | ||
Like exec, but the shell command will be executed _again_ after *reload*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
*exec*
sway/sway.5.scd
Outdated
|
||
*mouse\_warping* output|none | ||
If _output_ is specified, the mouse will be moved to new outputs as you | ||
move focus between them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Default is output
sway/sway.5.scd
Outdated
|
||
Examples: | ||
|
||
output HDMI-A-1 mode 1920x1080 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing one indentation level
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small typos, otherwise LGTM
https://git.sr.ht/~sircmpwn/scdoc
scdoc 1.3.0 supports tables, which is the missing piece needed to port sway's manual over to it.
Advantages of scdoc: