Skip to content

Commit

Permalink
Update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
gs-kamnas committed Aug 13, 2024
1 parent 69d6268 commit fb95193
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 22 deletions.
20 changes: 9 additions & 11 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,12 @@ $ ./configure
$ make
$ make install

Cntlm does not require any dynamic libraries and there are no dependencies you
have to satisfy before compilation, except for libpthreads. This library is
required for all threaded applications and is very likely to be part of your
system already, because it comes with libc. Next, install cntlm onto your
system like so:
Cntlm does not require any dynamic libraries unless kerberos support is enabled,
and there are no dependencies you have to satisfy before compilation,
except for libpthreads. This library is required for all threaded applications
and is very likely to be part of your system already, because it comes with libc.

Next, install cntlm onto your system like so:

Default installation directories are /usr/local/sbin, /usr/local/share/man and /etc.
Should you want to install cntlm into a different location, change the DESTDIR
Expand All @@ -132,7 +133,7 @@ $ make install SYSCONFDIR=/etc BINDIR=/usr/bin MANDIR=/usr/share/man

Cntlm is compiled with system-wide configuration file by default. That means
whenever you run cntlm, it looks into a hardcoded path (SYSCONFDIR) and tries
to load cntml.conf. You cannot make it not to do so, unless you use -c with an
to load cntlm.conf. You cannot make it not to do so, unless you use -c with an
alternative file or /dev/null. This is standard behaviour and probably what you
want. On the other hand, some of you might not want to use cntlm as a daemon
started by init scripts and you would prefer setting up everything on the
Expand All @@ -149,17 +150,14 @@ among other things a file called "cntlmd". It can be used as an init.d script.
Architectures
~~~~~~~~~~~~~
The build system now has an autodetection of the build arch endianness. Every
common CPU and OS out there is supported, including Windows, MacOS X, Linux,
common CPU and OS out there is supported, including Windows, MacOS, Linux,
*BSD, AIX.


Compilers
~~~~~~~~~
Cntlm is tested against GCC and IBM XL C/C++, other C compilers will work
Cntlm is tested against GCC, Clang and IBM XL C/C++, other C compilers will work
for you too. There are no compiler specific directives and options AFAIK.
compilers might work for you (then again, they might not). Specific
Makefiles for different compilers are supported by the ./configure script
(e.g. Makefile.xlc)


Contact
Expand Down
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Compile:
dpkg-buildpackage -b -rfakeroot

Upon installation, the package takes care of creating a dedicated user for
cntlm, init script integration, manages eventual configuration file updates
cntlm, systemd unit integration, manages eventual configuration file updates
with new upstream versions, things like restart of the daemon after future
updates, etc. You can later revert all these changes with one command, should
you decide to remove cntlm from your system.
Expand All @@ -62,12 +62,14 @@ you decide to remove cntlm from your system.

### 1) Quick way to create RPM

make rpm # you'll need root privs. or fakeroot utility
make rpm

### 2) Detailed howto (or if make rpm doesn't work for you)

To build an RPM package from scratch, as root change to
/usr/src/[redhat|rpm|whatever]/SOURCES
To build an RPM package from scratch:
* Ensure that the rpmdevtools package is present
* Execute `rpmdev-setuptree`
* Change to `~/rpmbuild/SOURCES`

Copy there all files from cntlm's rpm/ directory plus appropriate version of
the source tar.bz2 (see Creating a SOURCE TARBALL section above) and type:
Expand Down Expand Up @@ -162,29 +164,28 @@ whenever you run cntlm, it looks into a hardcoded path (SYSCONFDIR) and tries
to load cntml.conf. You cannot make it not to do so, unless you use -c with an
alternative file or /dev/null. This is standard behavior and probably what you
want. On the other hand, some of you might not want to use cntlm as a daemon
started by init scripts and you would prefer setting up everything on the
started by systemd units and you would prefer setting up everything on the
command line. This is possible, just comment out SYSCONFDIR variable definition
in the Makefile before you compile cntlm and it will remove this feature.

Installation includes the main binary, the man page (see "man cntlm") and if
the default config feature was not removed, it also installs a configuration
template. Please note that unlike bin and man targets, existing configuration
is never overwritten during installation. In the doc/ directory you can find
among other things a file called "cntlmd". It can be used as an init.d script.
is never overwritten during installation. In the linux/ directory you can find
among other things a files with a suffix of ".service" which implement systemd
unit files that can be used to manage cntlm, as either a system scoped or user
scoped service.

## Architectures

The build system now has an autodetection of the build arch endianness. Every
common CPU and OS out there is supported, including Windows, MacOS X, Linux,
common CPU and OS out there is supported, including Windows, MacOS, Linux,
*BSD, AIX.

## Compilers

Cntlm is tested against GCC, Clang and IBM XL C/C++, other C compilers will work
for you too. There are no compiler specific directives and options AFAIK.
compilers might work for you (then again, they might not). Specific
Makefiles for different compilers are supported by the ./configure script
(e.g. Makefile.xlc)

## Contact

Expand Down

0 comments on commit fb95193

Please sign in to comment.