Added a manual page for properties(1)
This commit is contained in:
parent
20503bc1f4
commit
ebd678bd52
1
Makefile
1
Makefile
|
@ -37,6 +37,7 @@ dist:
|
||||||
$(PACKAGE)-$(VERSION)/doc/browser.xml \
|
$(PACKAGE)-$(VERSION)/doc/browser.xml \
|
||||||
$(PACKAGE)-$(VERSION)/doc/desktop.xml \
|
$(PACKAGE)-$(VERSION)/doc/desktop.xml \
|
||||||
$(PACKAGE)-$(VERSION)/doc/desktopctl.xml \
|
$(PACKAGE)-$(VERSION)/doc/desktopctl.xml \
|
||||||
|
$(PACKAGE)-$(VERSION)/doc/properties.xml \
|
||||||
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
||||||
$(PACKAGE)-$(VERSION)/include/Browser.h \
|
$(PACKAGE)-$(VERSION)/include/Browser.h \
|
||||||
$(PACKAGE)-$(VERSION)/include/Makefile \
|
$(PACKAGE)-$(VERSION)/include/Makefile \
|
||||||
|
|
|
@ -4,3 +4,5 @@ desktop.1
|
||||||
desktop.html
|
desktop.html
|
||||||
desktopctl.1
|
desktopctl.1
|
||||||
desktopctl.html
|
desktopctl.html
|
||||||
|
properties.1
|
||||||
|
properties.html
|
||||||
|
|
14
doc/Makefile
14
doc/Makefile
|
@ -1,4 +1,4 @@
|
||||||
TARGETS = browser.1 browser.html desktop.1 desktop.html desktopctl.1 desktopctl.html
|
TARGETS = browser.1 browser.html desktop.1 desktop.html desktopctl.1 desktopctl.html properties.1 properties.html
|
||||||
PREFIX = /usr/local
|
PREFIX = /usr/local
|
||||||
DESTDIR =
|
DESTDIR =
|
||||||
RM ?= rm -f
|
RM ?= rm -f
|
||||||
|
@ -27,8 +27,14 @@ desktopctl.1: desktopctl.xml
|
||||||
desktopctl.html: desktopctl.xml
|
desktopctl.html: desktopctl.xml
|
||||||
./docbook.sh -P "$(PREFIX)" -- "desktopctl.html"
|
./docbook.sh -P "$(PREFIX)" -- "desktopctl.html"
|
||||||
|
|
||||||
|
properties.1: properties.xml
|
||||||
|
./docbook.sh -P "$(PREFIX)" -- "properties.1"
|
||||||
|
|
||||||
|
properties.html: properties.xml
|
||||||
|
./docbook.sh -P "$(PREFIX)" -- "properties.html"
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS) $(desktopctl.1_OBJS) $(desktopctl.html_OBJS)
|
$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS) $(desktopctl.1_OBJS) $(desktopctl.html_OBJS) $(properties.1_OBJS) $(properties.html_OBJS)
|
||||||
|
|
||||||
distclean: clean
|
distclean: clean
|
||||||
$(RM) -- $(TARGETS)
|
$(RM) -- $(TARGETS)
|
||||||
|
@ -40,6 +46,8 @@ install: $(TARGETS)
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktop.html"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktop.html"
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.1"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.1"
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.html"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.html"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "properties.1"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "properties.html"
|
||||||
|
|
||||||
uninstall:
|
uninstall:
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "browser.1"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "browser.1"
|
||||||
|
@ -48,5 +56,7 @@ uninstall:
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktop.html"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktop.html"
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.1"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.1"
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.html"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.html"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "properties.1"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "properties.html"
|
||||||
|
|
||||||
.PHONY: all clean distclean install uninstall
|
.PHONY: all clean distclean install uninstall
|
||||||
|
|
|
@ -82,9 +82,17 @@
|
||||||
<refentrytitle>desktop</refentrytitle>
|
<refentrytitle>desktop</refentrytitle>
|
||||||
<manvolnum>1</manvolnum>
|
<manvolnum>1</manvolnum>
|
||||||
</citerefentry>,
|
</citerefentry>,
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>desktopctl</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>,
|
||||||
<citerefentry>
|
<citerefentry>
|
||||||
<refentrytitle>move</refentrytitle>
|
<refentrytitle>move</refentrytitle>
|
||||||
<manvolnum>1</manvolnum>
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>,
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>properties</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
</citerefentry>
|
</citerefentry>
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
|
@ -135,6 +135,10 @@
|
||||||
<citerefentry>
|
<citerefentry>
|
||||||
<refentrytitle>desktopctl</refentrytitle>
|
<refentrytitle>desktopctl</refentrytitle>
|
||||||
<manvolnum>1</manvolnum>
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>,
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>properties</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
</citerefentry>
|
</citerefentry>
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
|
@ -162,6 +162,10 @@
|
||||||
<citerefentry>
|
<citerefentry>
|
||||||
<refentrytitle>desktop</refentrytitle>
|
<refentrytitle>desktop</refentrytitle>
|
||||||
<manvolnum>1</manvolnum>
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>,
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>properties</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
</citerefentry>
|
</citerefentry>
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
targets=browser.1,browser.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html
|
targets=browser.1,browser.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html,properties.1,properties.html
|
||||||
dist=Makefile,docbook.sh,browser.xml,desktop.xml,desktopctl.xml
|
dist=Makefile,docbook.sh,browser.xml,desktop.xml,desktopctl.xml,properties.xml
|
||||||
|
|
||||||
[browser.1]
|
[browser.1]
|
||||||
type=script
|
type=script
|
||||||
|
@ -36,3 +36,15 @@ type=script
|
||||||
script=./docbook.sh
|
script=./docbook.sh
|
||||||
install=
|
install=
|
||||||
depends=desktopctl.xml
|
depends=desktopctl.xml
|
||||||
|
|
||||||
|
[properties.1]
|
||||||
|
type=script
|
||||||
|
script=./docbook.sh
|
||||||
|
install=
|
||||||
|
depends=properties.xml
|
||||||
|
|
||||||
|
[properties.html]
|
||||||
|
type=script
|
||||||
|
script=./docbook.sh
|
||||||
|
install=
|
||||||
|
depends=properties.xml
|
||||||
|
|
94
doc/properties.xml
Normal file
94
doc/properties.xml
Normal file
|
@ -0,0 +1,94 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!-- $Id$ -->
|
||||||
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
||||||
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||||
|
<!ENTITY firstname "Pierre">
|
||||||
|
<!ENTITY surname "Pronchery">
|
||||||
|
<!ENTITY username "khorben">
|
||||||
|
<!ENTITY email "khorben@defora.org">
|
||||||
|
<!ENTITY section "1">
|
||||||
|
<!ENTITY title "Browser User Manual">
|
||||||
|
<!ENTITY package "DeforaOS Browser">
|
||||||
|
<!ENTITY name "properties">
|
||||||
|
<!ENTITY purpose "File and directory properties">
|
||||||
|
]>
|
||||||
|
<refentry>
|
||||||
|
<refentryinfo>
|
||||||
|
<title>&title;</title>
|
||||||
|
<productname>&package;</productname>
|
||||||
|
<authorgroup>
|
||||||
|
<author>
|
||||||
|
<firstname>&firstname;</firstname>
|
||||||
|
<surname>&surname;</surname>
|
||||||
|
<contrib>Code and documentation.</contrib>
|
||||||
|
<address>
|
||||||
|
<email>&email;</email>
|
||||||
|
</address>
|
||||||
|
</author>
|
||||||
|
</authorgroup>
|
||||||
|
<copyright>
|
||||||
|
<year>2012</year>
|
||||||
|
<holder>&firstname; &surname; <&email;></holder>
|
||||||
|
</copyright>
|
||||||
|
<legalnotice>
|
||||||
|
<para>This manual page was written for the DeforaOS project (and may be
|
||||||
|
used by others).</para>
|
||||||
|
<para>Permission is granted to copy, distribute and/or modify this
|
||||||
|
document under the terms of the GNU General Public License,
|
||||||
|
Version 3 as published by the Free Software Foundation.</para>
|
||||||
|
</legalnotice>
|
||||||
|
</refentryinfo>
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>&name;</refentrytitle>
|
||||||
|
<manvolnum>§ion;</manvolnum>
|
||||||
|
</refmeta>
|
||||||
|
<refnamediv>
|
||||||
|
<refname>&name;</refname>
|
||||||
|
<refpurpose>&purpose;</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>&name;</command>
|
||||||
|
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</refsynopsisdiv>
|
||||||
|
<refsect1 id="description">
|
||||||
|
<title>Description</title>
|
||||||
|
<para><command>&name;</command> is a modular, informative tool for files and
|
||||||
|
directories. It uses plug-ins from the
|
||||||
|
<citerefentry><refentrytitle>browser</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||||
|
file manager to display information and interact with any part of the
|
||||||
|
filesystem. It defaults to the "properties" and "preview" plug-ins, notably
|
||||||
|
allowing the alteration of access privileges on the target file(s), according
|
||||||
|
to the user's own privileges.</para>
|
||||||
|
</refsect1>
|
||||||
|
<refsect1 id="options">
|
||||||
|
<title>Options</title>
|
||||||
|
<para>No options are available; &name; expects an arbitrary number of files
|
||||||
|
and directories to be specified as arguments on the command line
|
||||||
|
instead.</para>
|
||||||
|
</refsect1>
|
||||||
|
<refsect1 id="bugs">
|
||||||
|
<title>Bugs</title>
|
||||||
|
<para>Issues can be listed and reported at <ulink
|
||||||
|
url="http://www.defora.org/os/project/bug_list/230/Browser"/>.</para>
|
||||||
|
</refsect1>
|
||||||
|
<refsect1 id="see_also">
|
||||||
|
<title>See also</title>
|
||||||
|
<para>
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>browser</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>,
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>desktop</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>,
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>desktopctl</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
</refentry>
|
||||||
|
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
Loading…
Reference in New Issue
Block a user