doc: Install rst based man pages
This commit is contained in:
parent
1e361fa9ca
commit
166f704e58
@ -40,7 +40,6 @@ add_subdirectory(doc/bash)
|
|||||||
add_subdirectory(doc/zsh)
|
add_subdirectory(doc/zsh)
|
||||||
add_subdirectory(include)
|
add_subdirectory(include)
|
||||||
add_subdirectory(lib)
|
add_subdirectory(lib)
|
||||||
add_subdirectory(man)
|
|
||||||
add_subdirectory(src bin)
|
add_subdirectory(src bin)
|
||||||
|
|
||||||
# We need to enable testing in the root folder so that 'ctest' and 'make test'
|
# We need to enable testing in the root folder so that 'ctest' and 'make test'
|
||||||
|
@ -97,10 +97,13 @@ install(FILES config
|
|||||||
|
|
||||||
add_custom_target(doc ALL
|
add_custom_target(doc ALL
|
||||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/doc
|
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/doc
|
||||||
COMMAND make html)
|
COMMAND make html man)
|
||||||
|
|
||||||
install(DIRECTORY build/html/
|
install(DIRECTORY build/html/
|
||||||
DESTINATION share/doc/polybar
|
DESTINATION share/doc/polybar
|
||||||
COMPONENT doc)
|
COMPONENT doc)
|
||||||
|
|
||||||
|
install(FILES build/man/polybar.1
|
||||||
|
DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man1
|
||||||
|
COMPONENT doc)
|
||||||
# }}}
|
# }}}
|
||||||
|
7
man/.gitignore
vendored
7
man/.gitignore
vendored
@ -1,7 +0,0 @@
|
|||||||
*.gz
|
|
||||||
*.ps
|
|
||||||
*.pdf
|
|
||||||
|
|
||||||
.*.swp
|
|
||||||
*~
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
|||||||
# Gets the date of the latest commit in the form YYYY-MM-DD
|
|
||||||
# This date is used in the man page
|
|
||||||
execute_process(COMMAND git log -1 --date=format:%Y-%m-%d --format=%cd
|
|
||||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
|
||||||
OUTPUT_VARIABLE LAST_COMMIT_DATE
|
|
||||||
OUTPUT_STRIP_TRAILING_WHITESPACE)
|
|
||||||
|
|
||||||
set(MAN_PAGES_1 polybar.1)
|
|
||||||
configure_file(
|
|
||||||
${CMAKE_CURRENT_LIST_DIR}/${MAN_PAGES_1}.cmake
|
|
||||||
${CMAKE_CURRENT_LIST_DIR}/${MAN_PAGES_1}
|
|
||||||
ESCAPE_QUOTES @ONLY)
|
|
||||||
|
|
||||||
INSTALL(FILES ${MAN_PAGES_1}
|
|
||||||
DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man1
|
|
||||||
COMPONENT doc)
|
|
@ -1,60 +0,0 @@
|
|||||||
.TH polybar 1 @LAST_COMMIT_DATE@ "polybar @APP_VERSION@" "User Manual"
|
|
||||||
.SH NAME
|
|
||||||
polybar \- A fast and easy-to-use tool status bar
|
|
||||||
.SH SYNOPSIS
|
|
||||||
\fBpolybar\fR [\fIOPTION\fR]... \fIBAR\fR
|
|
||||||
.SH DESCRIPTION
|
|
||||||
Polybar aims to help users build beautiful and highly customizable status bars for their desktop environment, without the need of having a black belt in shell scripting.
|
|
||||||
.TP
|
|
||||||
\fB\-h\fR, \fB\-\-help\fR
|
|
||||||
Display help text and exit
|
|
||||||
.TP
|
|
||||||
\fB\-v\fR, \fB\-\-version\fR
|
|
||||||
Display build details and exit
|
|
||||||
.TP
|
|
||||||
\fB\-l\fR, \fB\-\-log\fR=\fILEVEL\fR
|
|
||||||
Set the logging verbosity (default: \fBWARNING\fR)
|
|
||||||
.br
|
|
||||||
\fILEVEL\fR is one of: error, warning, info, trace
|
|
||||||
.TP
|
|
||||||
\fB\-q\fR, \fB\-\-quiet\fR
|
|
||||||
Be quiet (will override -l)
|
|
||||||
.TP
|
|
||||||
\fB\-c\fR, \fB\-\-config\fR=\fIFILE\fR
|
|
||||||
Specify the path to the configuration file. By default, the configuration file is loaded from:
|
|
||||||
.RS 10
|
|
||||||
.P
|
|
||||||
\fB$XDG_CONFIG_HOME/polybar/config\fR
|
|
||||||
.br
|
|
||||||
\fB$HOME/.config/polybar/config\fR
|
|
||||||
.P
|
|
||||||
.RE
|
|
||||||
.TP
|
|
||||||
\fB\-r\fR, \fB\-\-reload\fR
|
|
||||||
Reload the application when the config file has been modified
|
|
||||||
.TP
|
|
||||||
\fB\-d\fR, \fB\-\-dump\fR=\fIPARAM\fR
|
|
||||||
Print the value of the specified parameter \fIPARAM\fR in bar section and exit
|
|
||||||
.TP
|
|
||||||
\fB\-m\fR, \fB\-\-list\-monitors\fR
|
|
||||||
Print list of available monitors and exit
|
|
||||||
.TP
|
|
||||||
\fB\-w\fR, \fB\-\-print\-wmname\fR
|
|
||||||
Print the generated \fIWM_NAME\fR and exit
|
|
||||||
.TP
|
|
||||||
\fB\-s\fR, \fB\-\-stdout\fR
|
|
||||||
Output the data to stdout instead of drawing it to the X window
|
|
||||||
.TP
|
|
||||||
\fB\-p\fR, \fB\-\-png\fR=\fIFILE\fR
|
|
||||||
Save png snapshot to \fIFILE\fR after running for 3 seconds
|
|
||||||
.sp
|
|
||||||
.SH AUTHOR
|
|
||||||
Michael Carlberg <c@rlberg.se>
|
|
||||||
.br
|
|
||||||
Contributors can be listed on GitHub.
|
|
||||||
.SH REPORTING BUGS
|
|
||||||
Report issues on GitHub <https://github.com/jaagr/polybar>
|
|
||||||
.SH SEE ALSO
|
|
||||||
Full documentation at: <https://github.com/jaagr/polybar>
|
|
||||||
.br
|
|
||||||
Project wiki: <https://github.com/jaagr/polybar/wiki>
|
|
Loading…
Reference in New Issue
Block a user