This instance will be upgraded to Heptapod 0.20.1 on 2020-03-08 at 14:00 UTC+1 (10 minutes of downtime)

Commit 86b7643f authored by Gleb Popov's avatar Gleb Popov

Add manual pages for bsdisks.conf and bsdisks itself.

Submitted by: Pau Amma <pauamma@gundo.com>
parent 335dca7f6d14
......@@ -9,6 +9,7 @@ find_package(Qt5Core)
find_package(Qt5DBus)
option(INSTALL_POLKIT_RULES "Install polkit rules" OFF)
option(INSTALL_MAN_PAGES "Install man pages" ON)
add_definitions(-DINSTALL_PREFIX=\"${CMAKE_INSTALL_PREFIX}\")
......@@ -53,6 +54,13 @@ install(FILES bsdisks.conf.sample
DESTINATION etc/
)
install(FILES bsdisks.8
DESTINATION man/man8/
)
install(FILES bsdisks.conf.5
DESTINATION man/man5/
)
if(INSTALL_POLKIT_RULES)
install(FILES org.freedesktop.udisks2.policy
DESTINATION share/polkit-1/actions
......
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2020 Pau Amma <pauamma@gundo.com>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd July 3, 2020
.Dt BSDISKS 8
.Os
.Sh NAME
.Nm bsdisks
.Nd "command to implement the UDisks2 service"
.Sh SYNOPSIS
.Nm
.Op Fl -no-debug
.Sh DESCRIPTION
The UDisks2 service provides interfaces to enumerate
and perform operations on disks and storage devices
via the D-Bus API.
The
.Nm
command is an implementation of the UDisks2 service for
.Fx .
The following option is available:
.Bl -tag -width indent
.It Fl -no-debug
Suppress debugging output (that is, do not output anything).
.El
.Sh FILES
.Bl -tag -width /var/run/devd.seqpacket.pipe -compact
.It Pa /usr/local/etc/bsdisks.conf
Configuration file for
.Nm
.It Pa /var/run/devd.seqpacket.pipe
Pipe to read device and media events from
.Xr devd 8
.El
.Sh EXIT STATUS
.Ex -std
.Sh COMPATIBILITY
The
.Nm
utility is expected to be compatible with the UDisks2 daemon.
.Sh SEE ALSO
.Xr bsdisks.conf 5 ,
.Lk https://www.freedesktop.org/wiki/Software/udisks/
.Sh HISTORY
This manual page was written for version 0.17 of the
.Nm
utility.
.Sh AUTHORS
.An Gleb Popov Aq Mt arrowd@freebsd.org
wrote the
.Nm
utility, and
.An Pau Amma Aq Mt pauamma@gundo.com
wrote this manual page.
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2020 Pau Amma <pauamma@gundo.com>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd July 3, 2020
.Dt BSDISKS.CONF 5
.Os
.Sh NAME
.Nm bsdisks.conf
.Nd "configuration file for the bsdisks utility"
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
Lines in
.Nm
are limited to 1024 characters.
Lines where the first non-blank character is a # are comments and are
ignored.
Non-comment lines are of the form
.Ar name
=
.Ar value ,
where
.Ar name
can be:
.Bl -tag -width indent
.It mount_msdosfs_flags
Space-separated arguments to be passed to
.Xr mount_msdosfs 8 .
.El
.Sh SEE ALSO
.Xr bsdisks 8
.Sh HISTORY
This manual page was written for version 0.17 of the
.Nm bsdisks
utility.
.Sh AUTHORS
.An Gleb Popov Aq Mt arrowd@freebsd.org
wrote the
.Nm bsdisks
utility, and
.An Pau Amma Aq Mt pauamma@gundo.com
wrote this manual page.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment