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

Added a manual page for delete(1)

Browse Source
This commit is contained in:
Pierre Pronchery 2012-08-26 11:33:02 +00:00
parent b6d0bdbf79
commit fba8ebd168
10 changed files with 171 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/.cvsignore
View File

@ -1,5 +1,7 @@
browser.1
browser.html
delete.1
delete.html
desktop.1
desktop.html
desktopctl.1

14
doc/Makefile
View File

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

123
doc/delete.xml Normal file
View File

@ -0,0 +1,123 @@
<?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 "delete">
<!ENTITY purpose "Delete files and directories">
]>
<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>-f</option></arg>
<arg choice="opt"><option>-i</option></arg>
<arg choice="opt"><option>-r</option></arg>
<arg choice="opt"><option>-R</option></arg>
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> deletes files and directories specified from
the command line interface.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>The following options are available:</para>
<variablelist>
<varlistentry>
<term><option>-f</option></term>
<listitem>
<para>Do not prompt for confirmation and ignore errors.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option></term>
<listitem>
<para>Always ask before deleting or recursing to a sub-directory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r, -R</option></term>
<listitem>
<para>Allow recursion through sub-directories.</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>open</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>properties</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>view</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->

4
doc/desktop.xml
View File

@ -132,6 +132,10 @@
<refentrytitle>browser</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>delete</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>desktopctl</refentrytitle>
<manvolnum>1</manvolnum>

4
doc/desktopctl.xml
View File

@ -161,6 +161,10 @@
<refentrytitle>browser</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>delete</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>desktop</refentrytitle>
<manvolnum>1</manvolnum>

4
doc/open.xml
View File

@ -91,6 +91,10 @@
<refentrytitle>browser</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>delete</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>desktop</refentrytitle>
<manvolnum>1</manvolnum>

14
doc/project.conf
View File

@ -1,4 +1,4 @@
targets=browser.1,browser.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html,open.1,open.html,properties.1,properties.html,view.1,view.html
targets=browser.1,browser.html,delete.1,delete.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html,open.1,open.html,properties.1,properties.html,view.1,view.html
dist=Makefile,docbook.sh,browser.xml,desktop.xml,desktopctl.xml,open.xml,properties.xml,view.xml
[browser.1]
@ -13,6 +13,18 @@ script=./docbook.sh
install=
depends=browser.xml
[delete.1]
type=script
script=./docbook.sh
install=
depends=delete.xml
[delete.html]
type=script
script=./docbook.sh
install=
depends=delete.xml
[desktop.1]
type=script
script=./docbook.sh

4
doc/properties.xml
View File

@ -80,6 +80,10 @@
<refentrytitle>browser</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>delete</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>desktop</refentrytitle>
<manvolnum>1</manvolnum>

4
doc/view.xml
View File

@ -74,6 +74,10 @@
<refentrytitle>browser</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>delete</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>desktop</refentrytitle>
<manvolnum>1</manvolnum>

2
src/delete.c
View File

@ -450,7 +450,7 @@ static int _delete_filename_error(Delete * delete, char const * filename,
static int _usage(void)
{
fputs(_("Usage: delete [-fiRr] file...\n\
-f Do not prompt for confirmation or output error messages\n\
-f Do not prompt for confirmation and ignore errors\n\
-i Prompt for confirmation\n\
-R Remove file hierarchies\n\
-r Equivalent to -R\n"), stderr);