summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorgregory guy <[email protected]>2019-11-22 14:06:49 +0100
committerTDE Gitea <[email protected]>2019-11-27 14:01:24 +0000
commit8a5ab0cb65d78b80d7b9654077e24b8078b840df (patch)
treead68775a52c90009218061a07cc181a5acfb4470 /doc
parentc883e565c7ecc643a4cf9b5b8fdb0570f962f30c (diff)
downloadfilelight-8a5ab0cb65d78b80d7b9654077e24b8078b840df.tar.gz
filelight-8a5ab0cb65d78b80d7b9654077e24b8078b840df.zip
Drop automake build support.
Add basic cmake build instructions. Add a man page taken from Debian packaging. Delete empty file NEWS. Rework on the README, INSTALL and help page. Signed-off-by: gregory guy <[email protected]>
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/da/Makefile.am2
-rw-r--r--doc/es/Makefile.am2
-rw-r--r--doc/et/Makefile.am2
-rw-r--r--doc/filelight/Makefile.am2
-rw-r--r--doc/filelight/index.docbook29
-rw-r--r--doc/it/Makefile.am2
-rw-r--r--doc/man/CMakeLists.txt5
-rw-r--r--doc/man/filelight.163
-rw-r--r--doc/pt/Makefile.am2
-rw-r--r--doc/ru/Makefile.am2
-rw-r--r--doc/sv/Makefile.am2
12 files changed, 83 insertions, 31 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
deleted file mode 100644
index 54cb7de..0000000
--- a/doc/Makefile.am
+++ /dev/null
@@ -1 +0,0 @@
-SUBDIRS = $(AUTODIRS)
diff --git a/doc/da/Makefile.am b/doc/da/Makefile.am
deleted file mode 100644
index 63f44e7..0000000
--- a/doc/da/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_LANG = da
-KDE_DOCS = filelight
diff --git a/doc/es/Makefile.am b/doc/es/Makefile.am
deleted file mode 100644
index da3a4a7..0000000
--- a/doc/es/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_LANG = es
-KDE_DOCS = filelight
diff --git a/doc/et/Makefile.am b/doc/et/Makefile.am
deleted file mode 100644
index c8ffd54..0000000
--- a/doc/et/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_LANG = et
-KDE_DOCS = filelight
diff --git a/doc/filelight/Makefile.am b/doc/filelight/Makefile.am
deleted file mode 100644
index e97402c..0000000
--- a/doc/filelight/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_DOCS = AUTO
-KDE_LANG = en
diff --git a/doc/filelight/index.docbook b/doc/filelight/index.docbook
index f68d7de..7152d21 100644
--- a/doc/filelight/index.docbook
+++ b/doc/filelight/index.docbook
@@ -158,7 +158,7 @@ consistent documentation style across all KDE apps. -->
<para>The <guimenuitem>Appearance</guimenuitem> tab allows you to configure the way &filelight; looks.</para>
-<para>The <guimenuitem>Scheme</guimenuitem> section is used to choose a color scheme for &filelight;. The color schemes are Rainbow, KDE Colours, and High Contrast. There is also a <guimenuitem>Contrast:</guimenuitem> slider to adjust the contrast of the ring segments for easier viewing.</para>
+<para>The <guimenuitem>Scheme</guimenuitem> section is used to choose a color scheme for &filelight;. The color schemes are Rainbow, TDE Colours, and High Contrast. There is also a <guimenuitem>Contrast:</guimenuitem> slider to adjust the contrast of the ring segments for easier viewing.</para>
<para>The <guimenuitem>Use anti-aliasing</guimenuitem> checkbox is used to enable the use of anti-aliasing in the &filelight; view. Selected, this option makes the ring segments have a much cleaner look.</para>
@@ -175,17 +175,16 @@ consistent documentation style across all KDE apps. -->
<sect1 id="starting">
<title>Starting &filelight;</title>
-<para>&filelight; can be started from the K-Menu, or from the command-line</para>
+<para>&filelight; can be started from the TDE-Menu, or from the command-line</para>
<sect2 id="starting-from-the-menu">
-<title>From the K-Menu</title>
+<title>From the TDE-Menu</title>
<para>
-Open the &kde; program menu by clicking on the
-<guiicon>big K</guiicon> icon on your
+Open the Menu by clicking on the <guiicon>big "T-like"</guiicon> icon on your
panel. This will raise the <guimenu>program menu</guimenu>. Move your
-cursor up the menu to the <guimenu>Utilities</guimenu> menu item. Choose
-<guimenuitem>&filelight;</guimenuitem>.
+cursor up the menu to the <guimenu>Utilities</guimenu> menu item, then to <guimenu>File</guimenu>. Choose
+<guimenuitem>Disk Usage Statistics (Filelight)</guimenuitem>.
</para>
</sect2>
@@ -240,7 +239,7 @@ You can open directories with Konqueror or Konsole using the context menu for th
</para>
<para>
-If you want to improve the documentation, I'll happily accept patches :) Thanks.
+If you want to improve the documentation, We'll happily accept patches :) Thanks.
</para>
<!--<sect2 id="scan-home"><para>1</para></sect2>
@@ -487,9 +486,9 @@ If you want to improve the documentation, I'll happily accept patches :) Thanks.
<varlistentry>
<term><menuchoice>
<guimenu>Help</guimenu>
-<guimenuitem>About KDE</guimenuitem>
+<guimenuitem>About TDE</guimenuitem>
</menuchoice></term>
-<listitem><para><action>Starts the About &kde; dialog window.</action></para></listitem>
+<listitem><para><action>Starts the About &tde; dialog window.</action></para></listitem>
</varlistentry>
</variablelist>
@@ -577,8 +576,8 @@ Documentation copyright 2003 Max B. Howell <email>[email protected]</ema
<title>How to obtain &filelight;</title>
<para>
-&filelight; is not yet part of the KDE project, it can be found at:
-<ulink url="http://www.methylblue.com/filelight/">http://www.methylblue.com/filelight/</ulink>.
+&filelight; is now part of the TDE project, it can be found at:
+<ulink url="http://trinitydesktop.org/">http://trinitydesktop.org/</ulink>.
</para>
</sect1>
@@ -588,13 +587,15 @@ Documentation copyright 2003 Max B. Howell <email>[email protected]</ema
<para>
In order to compile and install &filelight; on your system, type the following in the base directory of the &filelight; distribution:
<screen width="40">
-<prompt>%</prompt> <userinput>./configure --prefix=`tde-config --prefix`</userinput>
+<prompt>%</prompt> <userinput>mkdir -p build</userinput>
+<prompt>%</prompt> <userinput>cd build</userinput>
+<prompt>%</prompt> <userinput>cmake ../</userinput>
<prompt>%</prompt> <userinput>make</userinput>
<prompt>%</prompt> <userinput>make install</userinput>
</screen>
</para>
-<para>Since &filelight; uses autoconf and automake you should have not trouble compiling it. Should you run into problems please report them to [email protected] or the &filelight; Forums.</para>
+<para>Since &filelight; uses cmake you should have not trouble compiling it. Default options for cmake build are available in the INSTALL file.</para>
</sect1>
diff --git a/doc/it/Makefile.am b/doc/it/Makefile.am
deleted file mode 100644
index cb1f57c..0000000
--- a/doc/it/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_LANG = it
-KDE_DOCS = filelight
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
new file mode 100644
index 0000000..8512250
--- /dev/null
+++ b/doc/man/CMakeLists.txt
@@ -0,0 +1,5 @@
+INSTALL(
+ FILES ${PROJECT_NAME}.1
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/filelight.1 b/doc/man/filelight.1
new file mode 100644
index 0000000..ce93298
--- /dev/null
+++ b/doc/man/filelight.1
@@ -0,0 +1,63 @@
+.\" Hey, EMACS: -*- nroff -*-
+.TH FILELIGHT 1 "March 14, 2007"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+filelight \- graphically display disk usage
+.SH SYNOPSIS
+.B filelight
+.RI [ " path " ]
+.SH DESCRIPTION
+\fBfilelight\fP allows you to understand exactly where your disk space
+is being used by graphically representing your file system as a set
+of concentric segmented rings, where each segment subtends an angle
+proportional to the disk space occupied by that file or directory.
+.PP
+You can specify a directory to scan on startup at the command line eg:
+.nf
+ filelight /home/mxcl
+.fi
+Starting at the root requires a scan of the entire directory tree,
+which may take a while.
+.PP
+\fBfilelight\fP is available in Konqueror under \fBView | View Mode | RadialMap View\fP.
+.SH RUN-TIME COMMANDS
+
+.TP
+.B Hover over segments
+to find out more about the region of the file system it represents.
+.TP
+.B Click on directories
+to see them in more detail (recenter the
+display on that directory).
+.TP
+.B Click on files
+to launch in the appropriate viewer (as configured in
+Konqueror).
+.TP
+.B Middle click
+to open files/directories with Konqueror.
+.TP
+.B Right click on the center white circle
+to manipulate the directory the view is centered about.
+.TP
+.B Enlarge the window
+for more detail - small files are hidden at
+smaller window sizes.
+.SH SEE ALSO
+.BR du (1),
+.BR df (1),
+.BR fsviewer (1),
+.BR gdmap (1),
+.BR philesight (1),
+.BR xcruiser (1).
+.BR xdiskusage (1).
+.br
+.SH BUGS
+Please report any bugs using the built-in bug reporter under
+the "help" menu, or to either [email protected] or the forums at
+http://www.methylblue.com/filelight/.
+.SH AUTHOR
+\fBfilelight\fP was written by Max Howell ([email protected]).
+.PP
+This manual page was written by J. R. Van Zandt,
+for the Debian project (but may be used by others).
diff --git a/doc/pt/Makefile.am b/doc/pt/Makefile.am
deleted file mode 100644
index ca3aa87..0000000
--- a/doc/pt/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_LANG = pt
-KDE_DOCS = filelight
diff --git a/doc/ru/Makefile.am b/doc/ru/Makefile.am
deleted file mode 100644
index 91982dc..0000000
--- a/doc/ru/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_LANG = ru
-KDE_DOCS = filelight
diff --git a/doc/sv/Makefile.am b/doc/sv/Makefile.am
deleted file mode 100644
index dd57bb9..0000000
--- a/doc/sv/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_LANG = sv
-KDE_DOCS = filelight