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

Port man pages to scdoc #1958

Merged
merged 12 commits into from May 12, 2018
Merged

Port man pages to scdoc #1958

merged 12 commits into from May 12, 2018

Conversation

ddevault
Copy link
Member

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:

  • Faster and smaller than asciidoc
  • Better syntax than asciidoc
  • Not feasible to localize the manual with asciidoc

@ddevault ddevault changed the title Port man pages to scdoc [WIP] Port man pages to scdoc May 11, 2018
sway/sway.1.scd Outdated
- /etc/sway/config
- /etc/i3/config

If unset, $XDG\_CONFIG\_HOME defalts to *~/.config*.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: defaults

@ddevault ddevault changed the title [WIP] Port man pages to scdoc Port man pages to scdoc May 12, 2018
@ddevault
Copy link
Member Author

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)
Copy link
Member

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".

Copy link
Member Author

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**
Copy link
Member

@emersion emersion May 12, 2018

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).
Copy link
Member

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).
Copy link
Member

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*.
Copy link
Member

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.
Copy link
Member

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing one indentation level

Copy link
Member

@emersion emersion left a 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

@ddevault ddevault merged commit 867190e into master May 12, 2018
@ddevault ddevault deleted the scdoc branch May 12, 2018 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants