DeforaOS/Browser
DeforaOS/Browser
2
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

Added a manual page for open(1)

Browse Source
This commit is contained in:
Pierre Pronchery 2012-06-21 23:14:47 +00:00
parent 1803022211
commit 50c2718264
5 changed files with 138 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile
View File

@ -37,6 +37,7 @@ dist:
$(PACKAGE)-$(VERSION)/doc/browser.xml \
$(PACKAGE)-$(VERSION)/doc/desktop.xml \
$(PACKAGE)-$(VERSION)/doc/desktopctl.xml \
$(PACKAGE)-$(VERSION)/doc/open.xml \
$(PACKAGE)-$(VERSION)/doc/properties.xml \
$(PACKAGE)-$(VERSION)/doc/project.conf \
$(PACKAGE)-$(VERSION)/include/Browser.h \

2
doc/.cvsignore
View File

@ -4,5 +4,7 @@ desktop.1
desktop.html
desktopctl.1
desktopctl.html
open.1
open.html
properties.1
properties.html

14
doc/Makefile
View File

@ -1,4 +1,4 @@
TARGETS = browser.1 browser.html desktop.1 desktop.html desktopctl.1 desktopctl.html properties.1 properties.html
TARGETS = browser.1 browser.html desktop.1 desktop.html desktopctl.1 desktopctl.html open.1 open.html properties.1 properties.html
PREFIX = /usr/local
DESTDIR =
RM ?= rm -f
@ -27,6 +27,12 @@ desktopctl.1: desktopctl.xml
desktopctl.html: desktopctl.xml
./docbook.sh -P "$(PREFIX)" -- "desktopctl.html"
open.1: open.xml
./docbook.sh -P "$(PREFIX)" -- "open.1"
open.html: open.xml
./docbook.sh -P "$(PREFIX)" -- "open.html"
properties.1: properties.xml
./docbook.sh -P "$(PREFIX)" -- "properties.1"
@ -34,7 +40,7 @@ properties.html: properties.xml
./docbook.sh -P "$(PREFIX)" -- "properties.html"
clean:
$(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)
$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS) $(desktopctl.1_OBJS) $(desktopctl.html_OBJS) $(open.1_OBJS) $(open.html_OBJS) $(properties.1_OBJS) $(properties.html_OBJS)
distclean: clean
$(RM) -- $(TARGETS)
@ -46,6 +52,8 @@ install: $(TARGETS)
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktop.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "open.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "open.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "properties.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "properties.html"
@ -56,6 +64,8 @@ uninstall:
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktop.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "open.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "open.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "properties.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "properties.html"

109
doc/open.xml Normal file
View File

@ -0,0 +1,109 @@
<?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 "open">
<!ENTITY purpose "Open and edit files with their registered handlers">
]>
<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; &lt;&email;&gt;</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>&section;</manvolnum>
</refmeta>
<refnamediv>
<refname>&name;</refname>
<refpurpose>&purpose;</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&name;</command>
<arg choice="opt"><option>-m</option> <replaceable>mime
type</replaceable></arg>
<arg choice="opt"><option>-a</option> <replaceable>action</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> automatically chooses the registered handler
to open one or more files from the command line interface.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>The following options are available:</para>
<variablelist>
<varlistentry>
<term><option>-a</option></term>
<listitem>
<para>Action to call. The default is "open".</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option></term>
<listitem>
<para>MIME type to force. The default behavior is to determine the MIME
type according to the respective file extension.</para>
</listitem>
</varlistentry>
</variablelist>
</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>,
<citerefentry>
<refentrytitle>properties</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->

16
doc/project.conf
View File

@ -1,5 +1,5 @@
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,properties.xml
targets=browser.1,browser.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html,open.1,open.html,properties.1,properties.html
dist=Makefile,docbook.sh,browser.xml,desktop.xml,desktopctl.xml,open.xml,properties.xml
[browser.1]
type=script
@ -37,6 +37,18 @@ script=./docbook.sh
install=
depends=desktopctl.xml
[open.1]
type=script
script=./docbook.sh
install=
depends=open.xml
[open.html]
type=script
script=./docbook.sh
install=
depends=open.xml
[properties.1]
type=script
script=./docbook.sh