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

doc: rewrite the style section of the manpage #1167

Open
ThomasAdam opened this issue Feb 8, 2025 · 0 comments
Open

doc: rewrite the style section of the manpage #1167

ThomasAdam opened this issue Feb 8, 2025 · 0 comments
Assignees
Labels
area:doc Relates to documentation only
Milestone

Comments

@ThomasAdam
Copy link
Member

The current section on Controlling Window Styles in fvwm3all, and hence
the generated fvwm3styles manpage is rather difficult to read.

The style options are currently separated into groups via / which were meant
to provide some sort of grouping, but over time, this was never going to be
sustainable.

To address this, it would be good to group the style options together, such
that they relate to:

  • Focus Policies
  • Window movement:
    ** Raising
    ** Resizing
    ** Maximising
    ** Shading
  • Window placement
  • Window decorations:
    ** Borders
    ** Handles
    ** CornerWidth
    ** etc...

Note that things like tables could be used to help with readability, including
bullet points, but bear in mind that asciidoctor only knows how to generate
groff(1) manpages. Some Linux distributions, and BSDs use mandoc(7) to render
man pages, and hence this isn't a superset of groff, so care should be taken
to not do anything too exotic.

@ThomasAdam ThomasAdam added the area:doc Relates to documentation only label Feb 8, 2025
@ThomasAdam ThomasAdam added this to the 1.1.3 milestone Feb 8, 2025
@ThomasAdam ThomasAdam self-assigned this Feb 8, 2025
@ThomasAdam ThomasAdam added this to FVWM3 Feb 8, 2025
@github-project-automation github-project-automation bot moved this to To do in FVWM3 Feb 8, 2025
@ThomasAdam ThomasAdam removed the status in FVWM3 Feb 8, 2025
@ThomasAdam ThomasAdam moved this to To do in FVWM3 Feb 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:doc Relates to documentation only
Projects
Status: To do
Development

No branches or pull requests

1 participant