aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPetr Machata <pmachata@redhat.com>2012-10-25 00:33:41 +0200
committerPetr Machata <pmachata@redhat.com>2012-10-25 00:33:41 +0200
commite4c829f9fcd3bcb3bc46c7fc078b486dfce2905b (patch)
treecbd1a71183bfd1027c3f663b53b3598441a138e1 /README
parent224d445cbe3e6199561df6ddb767083ca251d7c6 (diff)
downloadltrace-e4c829f9fcd3bcb3bc46c7fc078b486dfce2905b.tar.gz
Update README
Diffstat (limited to 'README')
-rw-r--r--README122
1 files changed, 76 insertions, 46 deletions
diff --git a/README b/README
index c021fed..3db5bc8 100644
--- a/README
+++ b/README
@@ -1,71 +1,101 @@
- ltrace
+This directory contains sources of ltrace. See the file configure.ac
+to see what version this is.
- A Dynamic Library Tracer
+Ltrace is a debugging program which runs a specified command until the
+command exits. While the command is executing, ltrace intercepts and
+records both the dynamic library calls called by the executed process
+and the signals received by the executed process. Ltrace can also
+intercept and print system calls executed by the process.
- Copyright 1997-2009 Juan Cespedes <cespedes@debian.org>
+For general building and installation instructions, see the file INSTALL.
+For list of authors and contributors, see the file CREDITS.
-Contents
---------
- 1. Introduction
- 2. Where can I find it
- 3. How does it work
- 4. Where does it work
- 5. Bugs
- 6. License
+ltrace is free software. See the file COPYING for license.
+Some documentation on ltrace usage is given in the manual page, which
+is in the file ltrace.1.
+Supported Targets
+-----------------
-1. Introduction
----------------
+The following targets are currently (at least somewhat) supported.
+Some of them may be more or less broken in reality, it is not feasible
+to test each release comprehensively on each target.
-ltrace is a debugging tool, similar to strace, but it traces library
-calls instead of system calls.
+ i[4567]86-*-linux-gnu
+ ia64-*-linux-gnu
+ m68k-*-linux-gnu
+ mips-*-linux-gnu
+ powerpc-*-linux-gnu
+ powerpc64-*-linux-gnu
+ s390-*-linux-gnu
+ s390x-*-linux-gnu
+ x86_64-*-linux-gnu
-2. Where can I find it
-----------------------
+The following systems were supported at some point in past, but
+current status is unknown:
-http://www.ltrace.org
+ sparc*-*-linux-gnu
+ sparc64*-*-linux-gnu
+ alpha*-*-linux-gnu
-3. How does it work
--------------------
+Support of the following systems is known to be broken and requires
+fixing:
-Using software breakpoints, just like gdb.
+ arm-*-linux-gnueabi
-4. Where does it work
----------------------
-It works with ELF based Linux systems running on i386, m68k, S/390,
-ARM, PowerPC, PowerPC64, IA64, AMD64, SPARC and Alpha processors.
+Bug Reports
+-----------
-It is part of at least Debian GNU/Linux, RedHat, SuSE, Mandrake...
+You can send bug reports to <ltrace-devel@lists.alioth.debian.org>.
+User requests can also be directed to that address.
-5. Bugs
--------
+If the ltrace package that you are using came with your operating
+system, please be sure to reproduce the problem in unmodified upstream
+version of ltrace before reporting a bug.
-Too many to list here :). If you like to submit a bug report, or a
-feature request, either do that against the Debian `ltrace' package,
-or mail ltrace-devel@lists.alioth.debian.org.
-This file is very incomplete and out-of-date.
+Development
+-----------
-6. License
-----------
+ltrace development is hosted by Alioth.Debian.org:
- Copyright (C) 1997-2009 Juan Cespedes <cespedes@debian.org>
+ https://alioth.debian.org/projects/ltrace/
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
+Release tarballs can be downloaded here:
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
+ https://alioth.debian.org/frs/?group_id=30892
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+Anonymous GIT access is available via:
+ git://git.debian.org/git/collab-maint/ltrace.git
+
+If you have anything to contribute, please send an e-mail to
+<ltrace-devel@lists.alioth.debian.org>, and attach your patches
+formatted with git format-patch. This makes them easy to apply after
+review, and such patches also preserve authorship.
+
+If you intend to work on a feature (essentially anything beyond a
+quick one-liner), it is advisable to send an e-mail beforehand.
+
+
+-------------------------------------------------------------------------------
+Copyright (C) 2012 Petr Machata <pmachata@redhat.com>
+Copyright (C) 1997-2009 Juan Cespedes <cespedes@debian.org>
+This file is part of ltrace.
+
+ltrace is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version.
+
+ltrace is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.