diff --git a/.clang-format b/.clang-format new file mode 100644 index 00000000..a0cb79c0 --- /dev/null +++ b/.clang-format @@ -0,0 +1,38 @@ +# IndentPPDirectives: AfterHash +# SpaceInParentheses: false +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: Empty +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +BinPackArguments: true +BinPackParameters: true +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Linux +BreakBeforeTernaryOperators: false +ColumnLimit: 100 +IndentCaseLabels: false +IndentWidth: 8 +IndentWrappedFunctionNames: true +KeepEmptyLinesAtTheStartOfBlocks: false +Language: Cpp +Cpp11BracedListStyle: false +MaxEmptyLinesToKeep: 1 +PointerAlignment: Right +SortIncludes: false +SpaceAfterCStyleCast: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesInCStyleCastParentheses: false +SpacesInSquareBrackets: false +TabWidth: 8 +UseTab: ForIndentation diff --git a/.github/workflows/abicheck.yml b/.github/workflows/abicheck.yml new file mode 100644 index 00000000..254c64f9 --- /dev/null +++ b/.github/workflows/abicheck.yml @@ -0,0 +1,127 @@ +on: [pull_request] +name: abicheck +env: + build_options: -Dbuildtype=debug -Denable-true-color=yes -Dwith-proxy=yes -Dc_args=-DPERL_EUPXS_ALWAYS_EXPORT + prefix: /usr/local + apt_build_deps: ninja-build libutf8proc-dev libperl-dev libotr5-dev libglib2.0-dev + get_pip_build_deps: pip3 install 'setuptools<66'; pip3 install wheel; pip3 install 'meson<0.59.0' + getabidef_def: getabidef() { awk '$1=="#define" && $2=="IRSSI_ABI_VERSION" { print $3 }' "$1"/include/irssi/src/common.h; } +jobs: + build-base-ref: + runs-on: ubuntu-latest + outputs: + base_abi: ${{ steps.out.outputs.base_abi }} + steps: + - name: set PATH + run: | + echo "$HOME/.local/bin" >> $GITHUB_PATH + - name: prepare required software + run: | + sudo apt update; sudo apt install $apt_build_deps + eval "$get_pip_build_deps" + - name: checkout base ref + uses: actions/checkout@main + with: + path: base.src + ref: ${{ github.base_ref }} + - name: build base ref + run: | + meson Build.base base.src $build_options + ninja -C Build.base + DESTDIR=$PWD/base ninja -C Build.base install + - id: out + run: | + # print versions and abi versions + eval "$getabidef_def" + base_abi=$(getabidef base$prefix) + echo base abi : $base_abi + ./base$prefix/bin/irssi --version + echo base_abi=$base_abi >> $GITHUB_OUTPUT + - uses: actions/upload-artifact@v4 + with: + name: base.inst + path: base + retention-days: 1 + build-merge-ref: + runs-on: ubuntu-latest + outputs: + merge_abi: ${{ steps.out.outputs.merge_abi }} + steps: + - name: set PATH + run: | + echo "$HOME/.local/bin" >> $GITHUB_PATH + - name: prepare required software + run: | + sudo apt update; sudo apt install $apt_build_deps + eval "$get_pip_build_deps" + - name: checkout merge ref + uses: actions/checkout@main + with: + path: merge.src + - name: build merge ref + run: | + meson Build.merge merge.src $build_options + ninja -C Build.merge + DESTDIR=$PWD/merge ninja -C Build.merge install + - id: out + run: | + # print versions and abi versions + eval "$getabidef_def" + merge_abi=$(getabidef merge$prefix) + echo merge abi : $merge_abi + ./merge$prefix/bin/irssi --version + echo merge_abi=$merge_abi >> $GITHUB_OUTPUT + - uses: actions/upload-artifact@v4 + with: + name: merge.inst + path: merge + retention-days: 1 + check-abi-diff: + runs-on: ubuntu-latest + needs: + - build-merge-ref + - build-base-ref + env: + base_abi: ${{ needs.build-base-ref.outputs.base_abi }} + merge_abi: ${{ needs.build-merge-ref.outputs.merge_abi }} + steps: + - name: prepare required software + run: | + sudo apt update; sudo apt install abigail-tools + - name: fetch base build + uses: actions/download-artifact@v4 + with: + name: base.inst + path: base + - name: fetch merge build + uses: actions/download-artifact@v4 + with: + name: merge.inst + path: merge + - run: | + # abipkgdiff + abipkgdiff -l base merge >abipkgdiff.out && diff_ret=0 || diff_ret=$? + echo "diff_ret=$diff_ret" >> $GITHUB_ENV + cat abipkgdiff.out + - uses: actions/upload-artifact@v4 + with: + path: abipkgdiff.out + - run: | + # Check if no changes are needed + if [ "$diff_ret" -ne 0 ]; then + if [ "$base_abi" -lt "$merge_abi" ]; then + echo "::warning ::abigail found changes and ABI changed from $base_abi to $merge_abi" + exit 0 + else + echo "::error ::Looks like the ABI changed but the IRSSI_ABI_VERSION did not" + exit $diff_ret + fi + else + if [ "$base_abi" -ne "$merge_abi" ]; then + echo "::error ::abigail found no changes yet the IRSSI_ABI_VERSION changed. Is this correct?" + exit 1 + else + : "No changes detected and IRSSI_ABI_VERSION untouched" + exit 0 + fi + fi diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml new file mode 100644 index 00000000..186c2e83 --- /dev/null +++ b/.github/workflows/check.yml @@ -0,0 +1,180 @@ +on: + push: + branches: + - master + pull_request: +name: Check Irssi +env: + apt_build_deps: ninja-build libutf8proc-dev libperl-dev libotr5-dev libglib2.0-dev + get_pip_build_deps_meson: pip3 install setuptools${setuptools_ver}; pip3 install wheel; pip3 install meson${meson_ver} + build_options_meson: -Dwith-proxy=yes -Dwith-bot=yes -Dwith-perl=yes -Dwith-otr=yes + prefix: ~/irssi-build +jobs: + dist: + runs-on: ubuntu-latest + env: + meson_ver: <0.63.0 + setuptools_ver: <66 + steps: + - name: prepare required software + run: | + sudo apt update && sudo apt install $apt_build_deps + eval "$get_pip_build_deps_meson" + patch ~/.local/lib/python3.12/site-packages/pkg_resources/__init__.py <<- PATCH + --- __init__.py 2024-12-16 20:37:46.733230351 +0100 + +++ __init__.py 2024-12-16 20:38:42.479554540 +0100 + @@ -2188,7 +2188,8 @@ def resolve_egg_link(path): + return next(dist_groups, ()) + + + -register_finder(pkgutil.ImpImporter, find_on_path) + +if hasattr(pkgutil, 'ImpImporter'): + + register_finder(pkgutil.ImpImporter, find_on_path) + + if hasattr(importlib_machinery, 'FileFinder'): + register_finder(importlib_machinery.FileFinder, find_on_path) + @@ -2345,7 +2346,8 @@ def file_ns_handler(importer, path_item, + return subpath + + + -register_namespace_handler(pkgutil.ImpImporter, file_ns_handler) + +if hasattr(pkgutil, 'ImpImporter'): + + register_namespace_handler(pkgutil.ImpImporter, file_ns_handler) + register_namespace_handler(zipimport.zipimporter, file_ns_handler) + + if hasattr(importlib_machinery, 'FileFinder'): + PATCH + - uses: actions/checkout@main + - name: make dist + run: | + ./utils/make-dist.sh + - uses: actions/upload-artifact@v4 + with: + path: irssi-*.tar.gz + retention-days: 1 + install: + runs-on: ${{ matrix.os }} + env: + CC: ${{ matrix.compiler }} + needs: dist + continue-on-error: ${{ contains(matrix.flags, 'FAILURE-OK') }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-22.04, ubuntu-latest] + compiler: [clang, gcc] + flags: [regular] + setuptools_ver: [<66] + include: + - os: ubuntu-22.04 + meson_ver: ==0.53.2 + setuptools_ver: <51 + - os: ubuntu-latest + meson_ver: <0.63.0 + - os: ubuntu-latest + flags: meson-latest FAILURE-OK + steps: + - name: fetch dist + uses: actions/download-artifact@v4 + - name: set PATH + run: | + echo "$HOME/.local/bin" >> $GITHUB_PATH + - name: prepare required software + env: + meson_ver: ${{ matrix.meson_ver }} + setuptools_ver: ${{ matrix.setuptools_ver }} + run: | + sudo apt update && sudo apt install $apt_build_deps + eval "$get_pip_build_deps_meson" + curl -SLf https://github.com/irssi-import/actions-irssi/raw/master/check-irssi/render.pl -o ~/render.pl && chmod +x ~/render.pl + - name: unpack archive + run: tar xaf artifact/irssi-*.tar.gz + - name: build and install with meson + run: | + # ninja install + cd irssi-*/ + meson Build $build_options_meson --prefix=${prefix/\~/~} + ninja -C Build + ninja -C Build install + - name: run tests with Meson + run: | + # ninja test + cd irssi-*/ + ninja -C Build test + find -name testlog.txt -exec sed -i -e '/Inherited environment:.* GITHUB/d' {} + -exec cat {} + + - name: run launch test + env: + TERM: xterm + run: | + # automated irssi launch test + cd + mkdir irssi-test + echo 'echo automated irssi launch test + ^set settings_autosave off + ^set -clear log_close_string + ^set -clear log_day_changed + ^set -clear log_open_string + ^set log_timestamp * + ^window log on + load irc + load dcc + load flood + load notifylist + load perl + load otr + load proxy + ^quit' > irssi-test/startup + irssi-build/bin/irssi --home irssi-test | perl -Mutf8 -C ~/render.pl + cat irc.log.* + annotation-warnings: + runs-on: ubuntu-latest + if: ${{ github.event_name == 'pull_request' }} + env: + CC: clang + steps: + - name: prepare required software + run: | + sudo apt update && sudo apt install $apt_build_deps + - uses: actions/checkout@main + - name: Setup local annotations + uses: irssi-import/actions-irssi/problem-matchers@master + - name: set PATH + run: | + echo "$HOME/.local/bin" >> $GITHUB_PATH + - name: prepare required software + env: + meson_ver: ${{ matrix.meson_ver }} + setuptools_ver: ${{ matrix.setuptools_ver }} + run: | + sudo apt update && sudo apt install $apt_build_deps + eval "$get_pip_build_deps_meson" + curl -SLf https://github.com/irssi-import/actions-irssi/raw/master/check-irssi/render.pl -o ~/render.pl && chmod +x ~/render.pl + - name: build and install with meson + run: | + meson Build $build_options_meson --prefix=${prefix/\~/~} + ninja -C Build + ninja -C Build install >/dev/null + - name: run launch test + env: + TERM: xterm + run: | + # automated irssi launch test + cd + mkdir irssi-test + echo 'echo automated irssi launch test + ^set settings_autosave off + ^set -clear log_close_string + ^set -clear log_day_changed + ^set -clear log_open_string + ^set log_timestamp * + ^window log on + load irc + load dcc + load flood + load notifylist + load perl + load otr + load proxy + ^quit' > irssi-test/startup + irssi-build/bin/irssi --home irssi-test | perl -Mutf8 -C ~/render.pl + cat irc.log.* diff --git a/.github/workflows/cifuzz.yml b/.github/workflows/cifuzz.yml new file mode 100644 index 00000000..3b20e427 --- /dev/null +++ b/.github/workflows/cifuzz.yml @@ -0,0 +1,51 @@ +name: CIFuzz +on: + pull_request: + paths: + - 'src/core/**/*.c' + - 'src/fe-common/core/**/*.c' + - 'src/fe-text/gui-*.c' + - 'src/irc/**/*.c' + - 'src/fe-common/irc/**/*.c' + - 'src/lib-config/**/*.c' + - 'src/fe-fuzz/**/*.c' + - 'tests/**/*.c' + - '.github/workflows/cifuzz.yml' +jobs: + Fuzzing: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + sanitizer: [address, undefined, memory] + steps: + - uses: actions/checkout@main + with: + path: irssi + - name: Docker build build_fuzzers container + run: | + # google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master + docker build -t build_fuzzers:actions -f "/home/runner/work/_actions/google/oss-fuzz/master/infra/build_fuzzers.Dockerfile" "/home/runner/work/_actions/google/oss-fuzz/master/infra" + - name: Build Fuzzers (${{ matrix.sanitizer }}) + id: build + env: + OSS_FUZZ_PROJECT_NAME: 'irssi' + DRY_RUN: false + SANITIZER: ${{ matrix.sanitizer }} + PROJECT_SRC_PATH: /github/workspace/irssi + REPOSITORY: 'irssi' + run: | + docker run --workdir /github/workspace --rm -e OSS_FUZZ_PROJECT_NAME -e DRY_RUN -e SANITIZER -e PROJECT_SRC_PATH -e REPOSITORY -e WORKSPACE=/github/workspace -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "$GITHUB_WORKSPACE":"/github/workspace" build_fuzzers:actions + - name: Run Fuzzers (${{ matrix.sanitizer }}) + uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master + with: + oss-fuzz-project-name: 'irssi' + fuzz-seconds: 600 + dry-run: false + sanitizer: ${{ matrix.sanitizer }} + - name: Upload Crash + uses: actions/upload-artifact@v4 + if: failure() && steps.build.outcome == 'success' + with: + name: ${{ matrix.sanitizer }}-artifacts + path: ./out/artifacts diff --git a/.github/workflows/clangformat.yml b/.github/workflows/clangformat.yml new file mode 100644 index 00000000..55aca4f3 --- /dev/null +++ b/.github/workflows/clangformat.yml @@ -0,0 +1,29 @@ +on: [pull_request] +name: clang-format +jobs: + check-clang-format: + runs-on: ubuntu-22.04 + steps: + - name: install clang-format + run: sudo apt install clang-format-14 + - uses: actions/checkout@main + - name: fetch target ref + run: + | + refs=($(git log -1 --format=%s)) + git fetch --depth=1 origin "${refs[3]}" + - name: configure clang-format + run: + | + git config clangformat.binary $PWD/utils/clang-format-xs/clang-format-xs + git config clangformat.extensions c,h,xs + - name: run git-clang-format and Check if no changes are needed + run: + | + CLANG_FORMAT=clang-format-14 git-clang-format-14 --diff FETCH_HEAD HEAD | tee git-clang-format.diff + cmp -s <(echo no modified files to format) git-clang-format.diff || cmp -s <(echo -n) git-clang-format.diff + - uses: actions/upload-artifact@v4 + if: failure() + with: + name: git-clang-format.diff + path: git-clang-format.diff diff --git a/.github/workflows/muon-fmt.yml b/.github/workflows/muon-fmt.yml new file mode 100644 index 00000000..6fa06d38 --- /dev/null +++ b/.github/workflows/muon-fmt.yml @@ -0,0 +1,32 @@ +name: Format meson files + +on: + push: + pull_request: + +permissions: {} + +jobs: + muon-meson-fmt: + name: Format + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + with: + persist-credentials: false + + # Build from source because Ubuntu 24.04 apt only has muon 0.2.0. + # Newer muons seem to format differently. + - name: Build muon from source + run: | + git clone --depth 1 --branch 0.5.0 https://github.com/muon-build/muon /tmp/muon + cd /tmp/muon + ./bootstrap.sh build + build/muon-bootstrap setup build + build/muon-bootstrap -C build samu + sudo build/muon -C build install + + - name: Run muon fmt + run: | + find . -name meson.build -print0 | xargs -0 muon fmt -c .muon_fmt.ini -i + git diff --exit-code diff --git a/.github/workflows/solarisvm.yml b/.github/workflows/solarisvm.yml new file mode 100644 index 00000000..da1ffa17 --- /dev/null +++ b/.github/workflows/solarisvm.yml @@ -0,0 +1,104 @@ +on: + push: + branches: + - master + pull_request: + workflow_dispatch: +name: Check Irssi on Solaris +env: + get_pip_build_deps_meson: pip3 install setuptools${setuptools_ver}; pip3 install wheel + prefix: ~/irssi-build +jobs: + dist: + runs-on: ubuntu-latest + env: + setuptools_ver: <66 + steps: + - name: prepare required software + run: | + sudo apt update && sudo apt install $apt_build_deps + eval "$get_pip_build_deps_meson" + patch ~/.local/lib/python3.12/site-packages/pkg_resources/__init__.py <<- PATCH + --- __init__.py 2024-12-16 20:37:46.733230351 +0100 + +++ __init__.py 2024-12-16 20:38:42.479554540 +0100 + @@ -2188,7 +2188,8 @@ def resolve_egg_link(path): + return next(dist_groups, ()) + + + -register_finder(pkgutil.ImpImporter, find_on_path) + +if hasattr(pkgutil, 'ImpImporter'): + + register_finder(pkgutil.ImpImporter, find_on_path) + + if hasattr(importlib_machinery, 'FileFinder'): + register_finder(importlib_machinery.FileFinder, find_on_path) + @@ -2345,7 +2346,8 @@ def file_ns_handler(importer, path_item, + return subpath + + + -register_namespace_handler(pkgutil.ImpImporter, file_ns_handler) + +if hasattr(pkgutil, 'ImpImporter'): + + register_namespace_handler(pkgutil.ImpImporter, file_ns_handler) + register_namespace_handler(zipimport.zipimporter, file_ns_handler) + + if hasattr(importlib_machinery, 'FileFinder'): + PATCH + - uses: actions/checkout@main + - name: make dist + run: | + ./utils/make-dist.sh + - uses: actions/upload-artifact@v4 + with: + path: irssi-*.tar.gz + retention-days: 1 + install: + runs-on: ubuntu-latest + needs: dist + steps: + - name: fetch dist + uses: actions/download-artifact@v4 + - name: Test in Solaris + uses: vmactions/solaris-vm@v1 + with: + usesh: true + sync: rsync + release: "11.4-gcc" + prepare: | + pkg update --accept || echo 1:$? + pkg install meson || echo 2:$? + pkgutil -y -i curl || echo 3:$? + pkgutil -y -i gtar || echo 4:$? + pkgutil -y -i findutils || echo 5:$? + run: | + set -ex + export PKG_CONFIG_PATH=/usr/lib/64/pkgconfig + curl -SLf https://github.com/irssi-import/actions-irssi/raw/master/check-irssi/render.pl -o ~/render.pl && chmod +x ~/render.pl + gtar xzf artifact/irssi-*.tar.gz + # ninja install + cd irssi-*/ + meson Build -Dwith-proxy=yes -Dwith-bot=yes -Dwith-perl=yes --prefix=$HOME/irssi-build + ninja -C Build + ninja -C Build install + # ninja test + ninja -C Build test + gfind -name testlog.txt -exec gsed -i -e '/Inherited environment:.* GITHUB/d' {} + -exec cat {} + + export TERM=xterm + # automated irssi launch test + cd + mkdir irssi-test + echo 'echo automated irssi launch test + ^set settings_autosave off + ^set -clear log_close_string + ^set -clear log_day_changed + ^set -clear log_open_string + ^set log_timestamp * + ^window log on + load irc + load dcc + load flood + load notifylist + load perl + load otr + load proxy + ^quit' > irssi-test/startup + irssi-build/bin/irssi --home irssi-test | perl -Mutf8 -C ~/render.pl + cat irc.log.* diff --git a/.github/workflows/termuxpkg.yml b/.github/workflows/termuxpkg.yml new file mode 100644 index 00000000..23f35695 --- /dev/null +++ b/.github/workflows/termuxpkg.yml @@ -0,0 +1,79 @@ +on: + push: + branches: + - master + pull_request: +name: Build Irssi Termux package +jobs: + termux-package: + runs-on: ubuntu-latest + steps: + - name: checkout termux-packages + uses: actions/checkout@main + with: + repository: termux/termux-packages + - name: checkout irssi + uses: actions/checkout@main + with: + path: src.irssi.git + - name: download termux docker container + uses: docker://termux/package-builder:latest + - name: create irssi build receipe + run: | + mkdir packages/irssi-an + cat << 'BUILD_SH' > packages/irssi-an/build.sh + TERMUX_PKG_HOMEPAGE=https://irssi.org/ + TERMUX_PKG_DESCRIPTION="Terminal based IRC client" + TERMUX_PKG_LICENSE="GPL-2.0" + TERMUX_PKG_MAINTAINER="@irssi" + TERMUX_PKG_VERSION=@VERSION@ + TERMUX_PKG_REVISION=@REVISION@ + TERMUX_PKG_SRCURL=git+file:///home/builder/termux-packages/src.irssi.git + TERMUX_PKG_AUTO_UPDATE=true + TERMUX_PKG_DEPENDS="glib, libandroid-glob, libiconv, libotr, ncurses, openssl, perl, utf8proc" + TERMUX_PKG_BREAKS="irssi" + TERMUX_PKG_REPLACES="irssi" + TERMUX_MESON_PERL_CROSS_FILE=$TERMUX_PKG_TMPDIR/meson-perl-cross-$TERMUX_ARCH.txt + TERMUX_PKG_EXTRA_CONFIGURE_ARGS=" + -Dfhs-prefix=$TERMUX_PREFIX + --cross-file $TERMUX_MESON_PERL_CROSS_FILE + " + + termux_step_pre_configure() { + LDFLAGS+=" -landroid-glob" + + # Make build log less noisy. + CFLAGS+=" -Wno-compound-token-split-by-macro" + + local perl_version=$(. $TERMUX_SCRIPTDIR/packages/perl/build.sh; echo $TERMUX_PKG_VERSION) + + cat << MESON_PERL_CROSS >$TERMUX_MESON_PERL_CROSS_FILE + [properties] + perl_version = '$perl_version' + perl_ccopts = ['-I$TERMUX_PREFIX/include', '-D_LARGEFILE_SOURCE', '-D_FILE_OFFSET_BITS=64', '-I$TERMUX_PREFIX/lib/perl5/$perl_version/${TERMUX_ARCH}-android/CORE'] + perl_ldopts = ['-Wl,-E', '-I$TERMUX_PREFIX/include', '-L$TERMUX_PREFIX/lib/perl5/$perl_version/${TERMUX_ARCH}-android/CORE', '-lperl', '-lm', '-ldl'] + perl_archname = '${TERMUX_ARCH}-android' + perl_installsitearch = '$TERMUX_PREFIX/lib/perl5/site_perl/$perl_version/${TERMUX_ARCH}-android' + perl_installvendorarch = '' + perl_inc = ['$TERMUX_PREFIX/lib/perl5/site_perl/$perl_version/${TERMUX_ARCH}-android', '$TERMUX_PREFIX/lib/perl5/site_perl/$perl_version', '$TERMUX_PREFIX/lib/perl5/$perl_version/${TERMUX_ARCH}-android', '$TERMUX_PREFIX/lib/perl5/$perl_version'] + MESON_PERL_CROSS + } + + BUILD_SH + version=$(awk '/^v/ { $0=$1; gsub(/^v/,""); gsub(/-head/,"dev"); gsub(/-/,""); print; exit }' src.irssi.git/NEWS) + version=$version+g$(git -C src.irssi.git rev-parse --short HEAD) + sed -i \ + -e "s:@VERSION@:$version:" \ + -e "s:@REVISION@:$GITHUB_RUN_NUMBER:" \ + packages/irssi-an/build.sh + git -C src.irssi.git tag v$version + - name: prepare output folder + run: | + install -m a+rwx -d output + - name: build irssi package + run: | + sudo ./scripts/run-docker.sh ./build-package.sh -I irssi-an + - uses: actions/upload-artifact@v4 + with: + name: irssi-termux-pkg + path: output/irssi-an*.deb diff --git a/.github/workflows/trigger-pages.yml b/.github/workflows/trigger-pages.yml new file mode 100644 index 00000000..0f2d3212 --- /dev/null +++ b/.github/workflows/trigger-pages.yml @@ -0,0 +1,20 @@ +on: + push: + branches: + - master + +jobs: + rebuild-pages: + if: github.repository == 'irssi/irssi' + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@v6 + with: + github-token: ${{ secrets.PAT_TOKEN }} + script: | + await github.rest.actions.createWorkflowDispatch({ + owner: context.repo.owner, + repo: 'irssi.github.io', + workflow_id: 'pages.yml', + ref: 'main' + }) diff --git a/.github/workflows/voiddocker.yml b/.github/workflows/voiddocker.yml new file mode 100644 index 00000000..9dc2addf --- /dev/null +++ b/.github/workflows/voiddocker.yml @@ -0,0 +1,75 @@ +on: + push: + branches: + - master + pull_request: + workflow_dispatch: +name: Check Irssi on Void Linux glibc +jobs: + dist: + runs-on: ubuntu-latest + container: ghcr.io/void-linux/void-glibc:latest + steps: + - name: prepare required software + run: | + xbps-install -Syu xbps || : + xbps-install -Syu + xbps-install -Sy git findutils python3-setuptools tar xz gzip + - uses: actions/checkout@main + - name: make dist + run: | + git config --global --add safe.directory /__w/irssi/irssi + ./utils/make-dist.sh + - uses: actions/upload-artifact@v4 + with: + path: irssi-*.tar.gz + retention-days: 1 + install: + runs-on: ubuntu-latest + container: ghcr.io/void-linux/void-glibc:latest + needs: dist + steps: + - name: prepare required software + run: | + xbps-install -Syu xbps || : + xbps-install -Syu + xbps-install -Sy meson base-devel libglib-devel libutf8proc-devel ncurses-devel ncurses-base openssl-devel libotr-devel libgcrypt-devel tar findutils curl + - name: fetch dist + uses: actions/download-artifact@v4 + - name: Setup local annotations + uses: irssi-import/actions-irssi/problem-matchers@master + - name: Test on Void Linux glibc + run: | + set -ex + curl -SLf https://github.com/irssi-import/actions-irssi/raw/master/check-irssi/render.pl -o ~/render.pl && chmod +x ~/render.pl + tar xzf artifact/irssi-*.tar.gz + # ninja install + cd irssi-*/ + meson Build -Dwith-proxy=yes -Dwith-bot=yes -Dwith-perl=yes --prefix=$HOME/irssi-build --buildtype debugoptimized + ninja -C Build + ninja -C Build install + # ninja test + ninja -C Build test + find -name testlog.txt -exec sed -i -e '/Inherited environment:.* GITHUB/d' {} + -exec cat {} + + export TERM=xterm + # automated irssi launch test + cd + mkdir irssi-test + echo 'echo automated irssi launch test + ^set settings_autosave off + ^set -clear log_close_string + ^set -clear log_day_changed + ^set -clear log_open_string + ^set log_timestamp * + ^window log on + load irc + load dcc + load flood + load notifylist + load perl + load otr + load proxy + ^quit' > irssi-test/startup + export LC_CTYPE=C.utf8 + irssi-build/bin/irssi --home irssi-test | perl -Mutf8 -C ~/render.pl + cat irc.log.* diff --git a/.gitignore b/.gitignore index 945b6cf6..ea2cd7ba 100644 --- a/.gitignore +++ b/.gitignore @@ -11,7 +11,6 @@ config.status configure default-config.h default-theme.h -faq.txt irssi-config irssi-config.h irssi-config.h.in @@ -28,13 +27,14 @@ MYMETA.* docs/help/Makefile.am docs/help/[a-z]* +!docs/help/meson.build !docs/help/in docs/help/in/Makefile.am src/fe-text/irssi - -src/fe-common/irc/irc-modules.c -src/irc/irc.c +src/fe-fuzz/irssi-fuzz +src/fe-fuzz/irc/core/event-get-params-fuzz +src/fe-fuzz/fe-common/core/theme-load-fuzz src/perl/perl-signals-list.h src/perl/irssi-core.pl.h @@ -46,11 +46,35 @@ src/perl/ui/*.c src/perl/*/MYMETA.* src/perl/*/Makefile.old +src/fe-fuzz/crash-* +src/fe-fuzz/oom-* + +/core +/irssi-1.pc +/irssi/ +/tests/fe-common/core/test-formats +/tests/fe-common/core/test-formats.log +/tests/fe-common/core/test-formats.trs +/tests/fe-common/core/test-suite.log +/tests/irc/core/core +/tests/irc/core/test-channel-events +/tests/irc/core/test-channel-events.log +/tests/irc/core/test-channel-events.trs +/tests/irc/core/test-irc +/tests/irc/core/test-irc.log +/tests/irc/core/test-irc.trs +/tests/irc/core/test-suite.log +/tests/irc/flood/test-796 +/tests/irc/flood/test-796.log +/tests/irc/flood/test-796.trs +/tests/irc/flood/test-suite.log + *.a *.bs *.la *.lo *.o +*.swp *~ *.tar.bz2 @@ -58,3 +82,10 @@ src/perl/*/Makefile.old .deps .libs + +Build +subprojects/* +!subprojects/*.wrap +Irssi-Dist +setup.cfg +*.egg-info diff --git a/.muon_fmt.ini b/.muon_fmt.ini new file mode 100644 index 00000000..47fce5d2 --- /dev/null +++ b/.muon_fmt.ini @@ -0,0 +1,14 @@ +# Irssi configuration for muon fmt +max_line_len = 108 +indent_style = space +indent_size = 2 +#indent_by = ' ' +space_array = true +kwargs_force_multiline = true +wide_colon = true +no_single_comma_function = true +insert_final_newline = true +sort_files = false +group_arg_value = true +sticky_parens = true +continuation_indent = true diff --git a/.obs/workflows.yml b/.obs/workflows.yml new file mode 100644 index 00000000..de815226 --- /dev/null +++ b/.obs/workflows.yml @@ -0,0 +1,13 @@ +workflow: + steps: + - branch_package: + source_project: home:ailin_nemui:irssi-git-an + source_package: irssi-git-an + target_project: home:ailin_nemui:CI + - set_flags: + flags: + - type: publish + status: enable + project: home:ailin_nemui:CI + filters: + event: pull_request diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 804dc58c..00000000 --- a/.travis.yml +++ /dev/null @@ -1,46 +0,0 @@ -sudo: false -language: perl -perl: - - "5.20-shrplib" - - "5.18-shrplib" - - "system-perl" -env: - - CC=clang - - CC=gcc - -addons: - apt: - packages: - - libperl-dev - - elinks - -before_install: - - perl -V - - ./autogen.sh --with-proxy --with-bot --with-perl=module - - make dist - - cd .. - - tar xaf */irssi-*.tar.* - - cd irssi-* - -install: - - ./configure --with-proxy --with-bot --with-perl=module --prefix=$HOME/irssi-build - - make CFLAGS="-Wall -Werror" - - make install - -before_script: - - cd - - mkdir irssi-test - - echo echo automated irssi launch test > irssi-test/startup; - echo ^set settings_autosave off >> irssi-test/startup; - echo ^set -clear log_close_string >> irssi-test/startup; - echo ^set -clear log_day_changed >> irssi-test/startup; - echo ^set -clear log_open_string >> irssi-test/startup; - echo ^set log_timestamp '* ' >> irssi-test/startup; - echo ^window log on >> irssi-test/startup - - echo load perl >> irssi-test/startup - - echo load proxy >> irssi-test/startup - - echo ^quit >> irssi-test/startup - - irssi-build/bin/irssi --home irssi-test - - cat irc.log.* - -script: true diff --git a/AUTHORS b/AUTHORS index eea359cc..db5ad2de 100644 --- a/AUTHORS +++ b/AUTHORS @@ -13,6 +13,7 @@ Irssi staff (current maintainers) : Jase Thew (bazerka) dequis (dx) Ailin Nemui (Nei) + Giuseppe (TheLemonMan, lemonboy) Former developers: @@ -26,7 +27,8 @@ Large feature patches by: Heikki Orsila : DCC SEND queueing Mark Trumbull : DCC SERVER Francesco Fracassi : Passive DCC - Giuseppe (The Lemon Man) + Uli Meis : OTR support + David Goulet : OTR support Other patches (grep for "patch" in ChangeLog) by: diff --git a/INSTALL b/INSTALL index 629a75c6..ac7c419f 100644 --- a/INSTALL +++ b/INSTALL @@ -2,68 +2,67 @@ Irssi installation instructions ------------------------------- -To compile irssi you need: +To compile Irssi you need: -- glib-2.6 or greater -- pkg-config +- meson-0.53 build system with ninja-1.8 or greater +- pkg-config (or compatible) +- glib-2.32 or greater - openssl (for ssl support) -- perl-5.6 or greater (for perl support) +- perl-5.8 or greater (for building, and optionally Perl scripts) + (n.b a complete perl is needed, including ExtUtils::Embed and xsubpp) - terminfo or ncurses (for text frontend) +- utf8proc (optional, for additional char width calculation) +- libgcrypt (for OTR) For most people, this should work just fine: - ./autogen.sh (for people who just cloned the repository) - ./configure (if this script already exists, skip ./autogen.sh) - make + meson Build + ninja -C Build su - make install (not _really_ required except for perl support) + ninja -C Build install + +meson options -configure options + These options can be given to meson. + + For a complete list of options, run + meson configure --prefix - Specifies the path where irssi will be installed. - YES, you can install irssi WITHOUT ROOT permissions + Specifies the path where Irssi will be installed. + YES, you can install Irssi WITHOUT ROOT permissions by using --prefix=/home/dir - --with-proxy + -Dwith-proxy=yes - Build the irssi proxy (see startup-HOWTO). + Build the Irssi proxy (see startup-HOWTO). - --disable-ssl - - Disable SSL support. - - --with-perl=[yes|no|module] + -Dwith-perl=[yes|no] Enable Perl support yes enable builtin (default) no disable - module enable as module - --with-perl-lib=[site|vendor|DIR] + -Dwith-perl-lib=[site|vendor|DIR] Specify installation dir for Perl libraries site install in dir for site-specific modules (default) vendor install in dir for vendor-specific modules DIR install in DIR - --with-socks - - Build with socks library - - --with-bot + -Dwith-bot=yes Build irssi-bot - --without-textui + -Dwithout-textui=yes Build without text frontend If anything is in non-standard path, you can just give the paths in -CPPFLAGS and LIBS environment variable, eg.: +the -Dc_args and -Dc_link_args options variable, eg.: - CPPFLAGS=-I/opt/openssl/include LDFLAGS=-L/opt/openssl/lib ./configure + meson Build -Dc_args='-I/opt/openssl/include' -Dc_link_args='-L/opt/openssl/lib' @@ -73,47 +72,51 @@ CPPFLAGS and LIBS environment variable, eg.: Perl support generates most of the problems. There's quite a many things that can go wrong: - - Compiling fails if you compile irssi with GCC in a system that has - perl compiled with some other C compiler. Very common problem with - non-Linux/BSD systems. You'll need to edit src/perl/*/Makefile files - and remove the parameters that gcc doesn't like. Mostly you'll just - need to keep the -I and -D parameters and add -fPIC. - If there's any weird crashing at startup, you might have older irssi's perl libraries installed somewhere, and you should remove those. - - Dynamic libraries don't want to work with some systems, so if your - system complains about some missing symbol in Irssi.so file, configure - irssi with --with-perl-staticlib option (NOT same as --with-perl=static). - - If configure complains that it doesn't find some perl stuff, you're + - If meson complains that it doesn't find some perl stuff, you're probably missing libperl.so or libperl.a. In debian, you'll need to do apt-get install libperl-dev - - For unprivileged home directory installations, you probably do not want - to specify --with-perl-lib=(site|vendor). Instead, you can use the - default perl installation target (below the irssi prefix). If you are - using local::lib you can also choose to install there by specifying - --with-perl-lib=$PERL_LOCAL_LIB_ROOT/lib/perl5 You can verify that the perl module is loaded and working with "/LOAD" command. It should print something like: Module Type Submodules ... -perl static core fe +perl dynamic fe core System specific notes --------------------- + Android + +When cross compiling Irssi for Android, you can specify the path of +the cross-perl in the cross file. + +You may not have a cross-perl available. In that case, you will have +to manually supply the required Perl arguments in the cross file. See +the commented properties in the example cross file. + +An example cross file can be found in the docs folder. To use it, you +would call: + + meson Build --cross-file cross-android-aarch64.txt \ + --prefix /data/data/com.termux/files/usr \ + --libdir lib \ + -Dfhs-prefix=/data/data/com.termux/files/usr \ + + Cygwin Getting perl scripting to work needs a few things: - - configure with --with-perl-staticlib + - TODO - - libperl.dll is required in linking and running irssi, it's normally - located somewhere around /usr/lib/perl5/5.6.1/cygwin/CORE/libperl5_6_1.dll - copy it to eg. /usr/bin/libperl.dll - - -DUSEIMPORTLIB is needed to be defined while compiling src/perl directory. - It doesn't hurt to be defined everywhere, so configure irssi with: + Apple MacOS / Darwin - CFLAGS='-DUSEIMPORTLIB' ./configure --with-perl-staticlib +At the time of writing, meson has an open issue with correctly linking +libraries on macos. + +See docs/meson-macos-ar.txt for a workaround. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 00000000..2cff9eba --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,35 @@ +global-include meson.build + +recursive-include src *.c *.h meson.build +recursive-include src/perl *.c *.h *.xs *.pm *.pl typemap meson.build +recursive-include src/fe-fuzz *.c *.h *.txt meson.build +recursive-include tests *.c meson.build + +include meson_options.txt + +include subprojects/*.wrap +# prune subprojects/* + +include utils/*.pl utils/*.sh +exclude utils/make-dist.sh + +include irssi.conf +include themes/*.theme +include docs/*.1 docs/*.txt docs/*.html +include docs/help/in/[a-z]*.in +include scripts/*.pl scripts/examples/*.pl +include irssi-icon.png + +include NEWS +include INSTALL +include TODO +include ChangeLog + +include .clang-format + +# prune Build +# prune dist +prune *.egg-info + +# ignore fuzz-support/fuzz.diff +# ignore utils/clang-format-xs/* diff --git a/Makefile.am b/Makefile.am deleted file mode 100644 index 75d502f1..00000000 --- a/Makefile.am +++ /dev/null @@ -1,39 +0,0 @@ -ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS} - -# create default-config.h -BUILT_SOURCES = default-config.h default-theme.h irssi-version.h -CLEANFILES = default-config.h default-theme.h - -@MAINTAINER_MODE_TRUE@.PHONY: irssi-version.h - -default-config.h: $(srcdir)/irssi.conf - $(srcdir)/file2header.sh $(srcdir)/irssi.conf default_config > default-config.h - -default-theme.h: $(srcdir)/default.theme - $(srcdir)/file2header.sh $(srcdir)/default.theme default_theme > default-theme.h - -irssi-version.h: - VERSION="$(VERSION)" $(srcdir)/irssi-version.sh $(srcdir) | \ - cmp -s - $@ || VERSION="$(VERSION)" $(srcdir)/irssi-version.sh $(srcdir) >$@ - -SUBDIRS = src docs scripts - -confdir = $(sysconfdir) -conf_DATA = irssi.conf - -themedir = $(datadir)/irssi/themes -theme_DATA = default.theme colorless.theme - -pkginclude_HEADERS = irssi-config.h irssi-version.h - -EXTRA_DIST = \ - ChangeLog \ - autogen.sh \ - README.md \ - file2header.sh \ - $(conf_DATA) \ - $(theme_DATA) \ - irssi-config.in \ - irssi-icon.png \ - irssi-version.sh \ - syntax.pl diff --git a/NEWS b/NEWS index 1709fbc3..571d251e 100644 --- a/NEWS +++ b/NEWS @@ -1,22 +1,769 @@ -v0.8.21-head 2016-xx-xx The Irssi team - * Removed --disable-ipv6 +v1.5-head 202x-xx-xx The Irssi team + +v1.4.5 2023-10-03 The Irssi team + + Add workaround for Perl 5.38.0 bug that breaks the Irssi + locale and glyph rendering (scripts.irssi.org#857, #1498) + - Fix Perl scripts broken by Perl 5.38 (scripts.irssi.org#851, + #1474). With input from Leon Timmermans + - Document workaround to fix linker errors when building with + meson on Apple (#1435, #1492) + - Fix meson using wrong filenames on Apple, leading to broken + Perl support (#1483, #1493) + - Fix /upgrade not accepting `~' (#1460, #1462). By Lukas Mai + - Improve compatibility with Perl5-IDEA (#1465, #1467). By + Charlie Daffern + - Fix logic in how own actions are printed for other protocols + (codeberg!5, #1471). By Andrej Kacian + - Fix crash on old PowerPC Mac (#1482, #1484) + - Fix wrong prototype of library function used in terminal + handling (#1495). By Emil Engler + - Minor cleanups (#1488, #1497). Includes work by Emil Engler + - Minor help and documentation fixes (#1458, #1494, #1477, + #1478). Includes work by KindOne + +v1.4.4 2023-03-31 The Irssi team + * Expose location of signals.txt via pkg-config (codeberg!1, + #1439, #1446, #1447). By Andrej Kacian + + Levels can now be inverted using `^' prefix in the /WINDOW + (HIDE)LEVEL commands (#1428) + + Support receiving monospace (#1370, #1442). By Linus + Heckemann + - Fix config broken by /WINDOW LOGFILE without parameter + (#1392, #1432) + - Fix broken /LASTLOG -window switch (#1418, #1424, regression + introduced in #1398) + - Fix logic in how actions are printed for other protocols + (codeberg!3, #1454). By Andrej Kacian + - Fix stale special collector use after free (#1456). Reported + by ednash + - Help and message fixes (#1421, #1429, #1431, #1434, #1438, + #1452, #1453, #1455). Includes work by Jimmie Tyrrell and + Sven Grewe + +v1.4.3 2022-10-31 The Irssi team + - Fix freeze on Alt+arrows (#1416, #1417) + - Fix crash on /upgrade (#1399, #1419) + - Fix saving of -disallow_starttls (#1401, #1420) + - Fix libnv detection on FreeBSD (freebsd#265397, #1407). By + Guido Falsi and Kristof Provost + - Minor help and script fixes (#1380, #1393, #1411, #1413, + #1414, #1415) + +v1.4.2 2022-07-17 The Irssi team + * Add irssimoduledir to irssi-1.pc in the Meson build (#1383, + #1378) + - Use -isystem includes, limiting warnings to Irssi + code. Fixes compilation with Perl 5.36 (#1381, + gentoo#851522, #1384) + - Fix missing lines when changing dynamic textbuffer contents + (#1382, #1387). Reported by externalserver15 + - Fix Perl cross compilation with Meson 0.60.0 (#1377) + - Fix default channel prefix used for /JOIN to default to `#' + (#1385, #1388) + - Fix crash in /LASTLOG by getting line texts before printing + (#1367, #1398) + +v1.4.1 2022-06-12 The Irssi team + ! Note: botti no longer compiles; get in touch if you use it + * Format the output of /QUOTE HELP (#1371, an#82). By Val + Lorentz. Add /SHELP as default alias (an#83) + + GLib log message filter: /SET glib_log_domains (an#50, + an#59). By Andrej Kacian + + An option to clear the cutbuffer: + /SET empty_kill_clears_cutbuffer (an#58). By Mikael + Magnusson + + Scriptable pastebin (an#60, an#88) + + Configurable actlist separator: /SET actlist_separator + (#1364, an#61) + - Fix window left/right not skipping visible windows + (an#57). By Mikael Magnusson + - Fix wrong printf-format on OpenBSD (an#66, an#68). Reported + by Aaron Bieber + - Fix erroneous output produced by autoload_modules (an#72) + - Fix scroll_page_count setting with `.' (#1365, an#76) + - Fix memory leak in /IGNORE (#1373, an#84). Found by Jookia + - Misc fixes (an#45, an#67, an#70, #1368, an#77) + + - CHANTYPES take precedence over (missing) STATUSMSG in /join + (#1358, an#54) + - Fix crash in Perl's $view->set_bookmark (freebsd#254237, + an#56) + + - Minor help fixes (an#51, an#52) + - Fix regression where own channel status was forgotten after + /UPGRADE (#1357, an#53) + + * /SET resolve_reverse_lookup setting was removed (#1034, + #1135) + * Irssi will try to connect on IPv4 if IPv6 connection failed + (#1146). By Shivaram Lingamneni + + * The display system now renders formats on the fly (#1079, + #1188, #1191, #1192, #1204, #1205, #1209, #1349, #1355, + an#13, an#14, an#28, an#29, an#36, an#37, an#49) + + This major change will break scripts that try to modify + printed text during "print text" signal (#1189). They need + to be ported to modify the text during "print format" + instead. It also breaks the usage of using /FORMAT to add + different colours to a line. Such usage needs to be ported + to using $expando variables instead. Affected scripts + include format_identify.pl, friends_peder.pl, nickcolor.pl, + nm.pl, people.pl + + The "gui print text finished" and "gui print text after + finished" signals gained a TEXT_DEST_REC *parameter in the + process. + + A new "gui render line text" signal is available to change + the rendering of a line + + * made the $Z expando (time) dynamic (#1087, #1207, #1208) + + This change breaks the usage of /SET timestamp_format to + supply a custom displayed time stamp. Affected scripts + include binary_time.pl + + * /HILIGHT -priority now affects which hilight rule gets + applied (#1228, #1232) + * The NAMES list is now hidden by default if there are more + than 18 users on the channel (an#7) + + To revert to the previous behaviour + + /SET show_names_on_join_limit -1 + + * -tls_verify is now enabled by default (#1170, an#18, #1309, + an#23, #1343, #1351) + + This may cause an ugly display of notls_verify in the output + of /SERVER LIST, even on plain-text connection, on old + configs. Kindly remove the "tls_verify = "no";" entries from + your config file manually. + + * Irssi will now attempt STARTTLS if advertised (#1170, #1312, + an#19) + + Use -disallow_starttls if you absolutely do not want this + + In order to check for a STARTTLS advertisement, Irssi will + now wait for a response (even an error) to CAP LS 302. If + your bouncer/server does not want to communicate before + receiving USER/PASS at all, use -nocap to disable the CAP + check. + + * Channel sync requests (WHO, MODE) are now sent "later" than + user commands. This should improve responsiveness to user + commands in the autojoin phase (#1300, an#26, an#32, an#33) + * Irssi is now using full paths in #include directives and + consequently does not add all directories to the include + path anymore (#1040) + * The Build System was ported to Meson (#1064, #1065, #1068, + #1071, #1072, #1073, #1074, #1075, #1084, #1085, #1118, #1166, + #1223, #1224, #1245, #1313, #1314, an#31) + * Scriptassist was changed to use a YAML database (#1163) + + It will tell you when you need to update your setting + + * /BIND shows all partial matches (#1155) + * Cleanup of unused functions (#1017, #1132, #1145, #1182, + #1246, #1264) + + Functions removed: + + NET_CALLBACK + NET_HOST_CALLBACK + RESOLVED_NAME_REC + net_gethostbyaddr_nonblock + net_connect_nonblock + [ SIMPLE_THREAD_REC, simple_init, simple_readpipe ] + hash_save_key + + Functions deprecated: + + dec2octal + g_timeval_cmp + get_timeval_diff + + Function names corrected: + + g_input -> i_input + g_istr -> i_istr + g_io_channel -> i_io_channel + g_hash_free_value -> i_hash_free_value + remove g_free_true + gslist -> i_slist + glog_func -> i_log_func + glist -> i_list + + If multi-version compatibility is desired, module authors + can find an example of backwards compatible code in + cdidier/irssi-xmpp#55 + + + Add MSGLEVEL_HIDDEN to Perl (#1044) + + Add $view->set_hidden_level and $view->remove_lines_by_level + to Perl (#1026) + + Add a /SET scrollback_max_age setting (#1022). By Heikki + Orsila + + Add /SET actlist_prefer_window_name (#1025) + + Add -window option to /CAT (#1023, #1159) + + Add an option to list specific sections with + + /SET -section lookandfeel + + (#1048) + + + Add support for IRCv3 CAP LS 302 (#1091) + + Add a new "print noformat" signal that goes together with + "print format" (#1088, #1192) + + Add support for IRCv3 extended-join. /SET show_extended_join + to enable (#1097, #1107, #1124) + + There are two new /FORMATs, join_extended and + join_extended_account, that theme writers need to take into + account if desired. + + + Add support for IRCv3 setname (#1093, #1104, #1254, GL#33) + + Add support for IRCv3 account-notify (#1100, #1098, GL#33, + #1105, #1131). Credit to oss-fuzz + /SET show_account_notify to enable + + Add support for IRCv3 invite-notify (#1094) + + Add support for receiving IRCv3 message-tags (#576, #1090) + + Add support for sending IRCv3 message-tags (#1092, an#34) + + Enable the znc.in/self-message CAP by default (#1123) + + Add support for IRCv3 away-notify. /SET away_notify_public + to enable (#1099, GL#33, #1105) + + Add support for IRCv3 chghost (#1096, GL#33, #1105) + + For servers with broken chghost implementation that fill the + status window with host changed messages, one may add "quote + cap req -chghost" to the -autosendcmd or, if the host change + messages are entirely undesired, "/format -delete + host_changed" + + + Add support for IRCv3 server-time. /SET show_server_time to + enable (#1108) + + Add support for logging IRCv3 server-time. + /SET log_server_time to disable (#1318, an#16) + + Add IRCv3 features to signals.txt (#1111) + + In particular, "message join" now takes 2 additional + arguments, script and module authors must beware of this + change. + + + Show the unignore time in /IGNORE output (#1158, #1161) + + Add /SET quit_on_hup to make the behaviour of SIGHUP + configurable (#828, #1169). By Pinguin1234 + + Support numeric 489 as ERR_SECUREONLYCHAN (#1193, #1196). By + Michael Hansen + + Improve support for building Irssi in Termux-Android with + Meson (#1199) + + Add usermode key to Irssi::Irc::Chatnet in Perl (#1288). By + Jessica Sophie Porter + + Add format_string_expand and format_string_unexpand + functions to Perl (#1286) + + Add ...->format_create_dest(...)->printformat("format", + args...) and ...->printformat_module("module", "format", + args...) methods to Perl (#1284) + + You can avoid any CORE::GLOBAL::caller hacks using the + printformat_module method, especially sind that hack was not + safe during signal emissions + + + Add tracking of user accounts in the channel nicklist using + WHOX on join (#1250) + + Add auto-loading of the Perl and otr module from /SET + autoload_modules (#1295) + + Add /IGNORE ... NOHILIGHT to ignore some hilights (#1260) + + Do not beep on hidden lines with /SET beep_msg_level + ... -HIDDEN (#1259) + + Added /CS, /MS, /NS, and /OS aliases to the default config + (#1316). By Mathis Beer + + Allow -tls_ca{file,path} '' to unset an argument (#730, + #1060, an#30) + + Add a "server outgoing modify" signal to intercept outgoing + messages (#1148, #1151, an#15, an#43). Original by + JustAnotherArchivist + - remove some hard-coded 510 byte assumptions (#1086) + - Several fixes for error checks in SSL (#944, #1037, #943, + #1036). Reported by Chi Li + - Wrong variable tested in mask_match (#902, #1035) + - Fix bug where irssi-proxy with `?'-port would not reconnect + (#1041) + - Allow shrinking of /SET rawlog_lines (#957, #1020). By + Marcus "Teschi" Prinz + - Fix /WINDOW BALANCE warning (#1054) + - fix overflow when first command history entry expires + (#1070) + - begin modularising IRC module (#1067, #1112, #1113) + - fix some memory leaks in /DCC RESUME and settings_add + (#1077). By Zero King + - fix cut-off text with theme_indent module and /SET + indent_always OFF (#1078) + - fix the cap_queue order (#1095) + - add reference counted strings (#1089) + - Fix irc_op_public messages not triggering hilights (#354, + #891, #1129). By Dan Collins + - Fix /IGNORE not setting the right level in irc_op_public + messages (#1280). Credit to oss-fuzz + - Fix GTimeVal deprecation (#1141, #1144, #1145, #1350, an#44) + + If multi-version compatibility is desired, module authors + can find an example of backwards compatible code in + cdidier/irssi-xmpp#53 + + - Fix /IGNORE ... MODES NO_ACT not working (#1164) + - Deprecated -ssl* options are hidden from tab completion + (#1171) + - Make /SET actlist_sort a choice type (#1198) + - Fix crash from self-unloading script (#1206). By Thomas + Stagner + - Fix crash during Perl signal emission (#1233, #1234) + - Fix a case where empty lines or comments inside channels or + servers in the config would confuse Irssi (#1062, #1242, + #1243) + - Fix reported freezing in DCC GET on slow disks (#159, #1271) + - Fix message-tags parsing (#1274, #1275). Credit to oss-fuzz + - Fail redirects when receiving numeric 263 (RPL_TRYAGAIN) in + response to /WHO (#1283) + - Some updates to .gitignore (#1302). By Rene Kita + - Fix build on operating systems with X/Open Curses, version 2 + (#1305, #1308). By Nia Alarie (Regression introduced with + #1290, alternative fix for Irssi 1.2.3 no-term.h.patch) + - Fix otr module not using g_strndup, e.g. on Solaris 10 + (#1315). By Claes Nästén + - Fix cursor getting stuck for auto completions that changes + case (#1176, #1322, an#8). By ffrogman + - Restore operation of tag/* in /SET activity_hide_targets + (#1337, an#11) nb. the ::all syntax was working in Irssi 1.1 + and 1.2 (and continues to work) + - Fix /SERVER ADD -matrix -network my_matrix_network + (an#12). By Andrej Kacian + - Fix /SERVER ADD creating duplicated entries in the config + file (#1317, an#22, an#41) + - Fix critical when SASL user is set and SASL password is + empty (#1325, an#21) + - Misc fixes (#1106, #1141, #1272, #1297, an#35) + - Fuzz fixes (#1116, #1117, #1119, #1125, #1126, an#20) + - Build system fixes (#1101, #1102, #1069, #1140, #1181, #1253) + - Sync docs and scripts (an#39) + - Text and Help updates + - add -tls_* options to manual (#1029, #1030). By Jacob + V. Rasmussen + - missing targets in /MSG (#1032) + - wrong parameter in /ECHO (#1024) + - Spelling in OTR (#1047). By David Gall + - Clarify statusbar priority (#1049). By Marius Gedminas + - Document get_irssi_dir in Perl (#1051, #1052). By Alex + Shafer + - typo in /HILIGHT help (#1081). By DFrostByte + - improved clarity of your_nick_owned (#1138). By Mike Quin + - Update some URLs to https (#1163) + - Add documentation for escaping some characters (#1329, + #1330, an#9). By Guntbert Reiter + - Fix some typos (#1336, an#10). By Francis Mteo + - Document $abiversion and parse_special (an#38). By bw1 + - Infrastructure updates: + - Support for Github Actions (#1039, #1103, #1160, #1212, + #1231, #1252, #1261, an#40) + - Run clang-format on pull requests (#1172, #1173, #1184, + #1230, #1247, #1287) + - Run abidiff on pull requests (#1179, #1195) + - Test CI-Fuzz (#1279, #1304, an#17) + +v1.2.3 2021-04-11 The Irssi team + - Fix the compilation of utf8proc (#1021) + - Fix wrong call to free. By Zero King (#1076) + - Fix a colour reset in true colour themes when encountering + mIRC colours (#1059) + - Fix memory leak on malformed CAP requests (#1120) + - Fix an erroneous free of SASL data. Credit to Oss-Fuzz (#1128, + #1130) + - Re-set the TLS flag when reconnecting (#1027, #1134) + - Fix the scrollback getting stuck after /clear (#1115, #1136) + - Fix the input of Ctrl+C as the first character (#1153, #1154) + - Fix crash on quit during unloading of modules on certain + platforms (#1167) + - Fix Irssi freezing input after Ctrl+Space on GLib >2.62 (#1180, + #1183) + - Fix layout of IDCHANs. By Lauri Tirkkonen (#1197) + - Fix crash when server got reconnected before it was properly + connected (#1210, #1211) + - Fix multiple identical active caps (#1249) + - Minor help corrections (#1156, #1213, #1214, #1255) + - Remove erroneous colour in the colorless theme. Reported and + fixed by Nutchanon Wetchasit (#1220, #1221) + - Fix invalid bounds calculation when editing the text + entry. Found and fixed by Sergey Valentey (#1269) + - Fix passing of negative size in buffer writes. Found and + fixed by Sergey Valentey (#1270) + - Fix Irssi freezing on slow hardware and fast DCC transfers (#159, + #1271) + - Fix compilation on Solaris (#1291) + - Fix null pointer dereference when receiving broken JOIN + record. Credit to Oss-Fuzz (#1292) + - Fix crash on /connect to some sockets (#1239, #1298) + - Fix Irssi rendering on Apple ARM. By Misty De Méo (#1267, + #1268, #1290) + - Fix crash on /lastlog with broken lines (#1281, #1299) + - Fix memory leak when receiving bogus SASL authentication + data. Found and fixed by Sergey Valentey (#1293) + +v1.2.2 2019-08-29 The Irssi team + - Fix a use after free issue when receiving IRCv3 CAP + information from the server (GL#34, GL!35) + - Fix a crash during startup when windows weren't fully + initialised yet (#1114, bdo#935813) + +v1.2.1 2019-06-29 The Irssi team + ! Contains all changes from 1.1.3 + - Fix a test on big endian machines (#1014) + - Fix the compile time conditionality of wcwidth + implementation (#1019, gentoo#677804, #720) + - Fix /save no longer working on old Solaris (pre + POSIX.1-2008) (#1042, #1043) + - Fix regression of #764 where display of 8-bit (legacy + encoding) in the input prompt was broken (#1018, + #1057). Initial patch by Артём Курашов + +v1.1.3 2019-06-29 The Irssi team + ! Contains all changes from 1.0.8 + - Fix regression of #779 where autolog_ignore_targets would + not matching itemless windows anymore (#1012, #1013) + +v1.0.8 2019-06-29 The Irssi team + - Fix a use after free issue when sending the SASL login on + (automatic and manual) reconnects (#1055, #1058). Reported + by ilbelkyr + +v1.2.0 2019-02-11 The Irssi team + ! Contains all changes from 1.1.2 + * Improved the /STATUSBAR commands (#858) + * /SET no longer shows `=' between setting and value (#886) + * /CUBES removed from default config (available as script) + (#956) + * /1 /2 /3 ... removed from default config (available as new + setting window_number_commands) (#958) + * Always redraw the screen on resize. By David Phillips (#896) + * Private notices intended for channels are now displayed on + the channel (new setting notice_channel_context) (#959) + + Imported the "Off-the-record" module into Irssi tree (#854, + #589, #196, #881) + + Initial support for sideways split windows (#697, #431, + #224, #807, FS#310, #947, #955, #989) + + Change the implementation of `wcwidth'. This is used to + calculate the width of emojis on your terminal screen (#917, + #720) + + Make the wcwidth functions available from Perl (#973): + + string_width(str) + string_chars_for_width(str, width) + wcwidth(char) + + + Added completion_keep_word setting (#979) + + Allow activity_hide_targets to hide activity in itemless + windows (#967, #997, #1001, #1003) + + Added activity_hide_visible setting (#990) + + Allow hiding of lines through the /IGNORE system (#901, + #900, #892, #890, #884, #937) + + Add window_default_hidelevel setting. By Doug Freed (#941) + + Add activity_hide_window_hidelevel setting, defaulting to ON + (#938) + + Add autolog_only_saved_channels setting, to autolog only + channels that are in the config (#968) + + Add format support for the input line. By Ben Paxton, + originally by Jonas Hurrelmann (#764, FS#621, #1004) + + use Irssi::TextUI; + gui_input_set_extent(pos, text) + gui_input_set_extents(pos, len, left, right) + gui_input_clear_extents(pos, len) + gui_input_get_extent(pos) + gui_input_get_text_and_extents() + gui_input_set_text_and_extents(...) + + + Parsing of IRCv3 CAP 3.2 (#775, #869) + + Show CAP-related events in the user interface (#918, #916, + #870, #704) + + Continue using separators when addressing multiple nicks + with tab completion. By Manish Goregaokar (#822) + + Bind Shift-tab by default. By Niklas Luokkala (#830, #829) + + Fuzzing more things (#913, #780, #813) + - Disconnect SASL properly in case the SASL module got + unloaded from server (#931, #629, #618, #616) + - Fix backward completion jumping to the first instead of last + word (#979) + - Improve empty topic handling (#961, #905, #911, #897, #888) + - Prevent config truncation when no space left. By dequis and + Lukas Waymann (#922, #925, #910, #909, #906, #871, #817) + - Also time-out servers in lookup phase (#866, #130) + - Fix build with LibreSSL 2.7. By Dorian Harmans (#865) + - Fix a crash when appending to a textbuffer without + line. Reported by Jari Matilainen (#862) + - Fix segfault on sending large messages (#803, #796, #802) + - Fix segfault on invalid statusbar config (#993, #994) + - Fix random memory writes on restoring queries of foreign + protocols (#999, #1000) + - Make default keybinds deletable (#859, #507) + - Fix freeze when resizing Irssi very small (#946) + - Compare channels case-insensitively, avoiding confusions + with the config file (#857, #856) + - Fix DCC GET on Android. By Martin Staron (#844) + - Improve rawlog performance (#957) + - Fix nick escaping erroneously escaping quotes (#978, #974, + #709) + - Protect against theme recursion, improve padding + performance, limit alignment padding. Credit to Oss-Fuzz + (#835, #851, #850, #846, #848) + - Fix recursive loop in replaces (#833, GL#23) + - Fix headers for compilation of C modules (#939) + - Documentation. By Zero King (#814). (#852) + - Sync NEWS, docs, scripts (#849, #855) + - Build system (#868, #867, #985, #988) + - Fix build on IBM i and AIX. By Calvin Buckley (#975) + - Misc fixes (#840, #839, #843, #953, #962). Tests (#806, + #875, #905, #964, #1011). Fuzzing (#929). + +v1.1.2 2019-01-09 The Irssi team + - Fix the resetting of window hiddenlevel (#861) + - Fix clearing of hidelevel in layout (#951) + - Fix accessing unallocated text when checking entry position + (#928, #930) + - Fix uninitialised memory on empty lines (#873, GL#31, #878, + #877, #907, #914) + - Fix use-after-free on expiration of hidden lines (#948) + - Fix use-after-frees. By Maya Rashish (#919) + - Fix out of bounds access in help display when window width + is small (#949) + - Fix paste_join_multiline (#970, #971) + - Correctly check for errno when displaying SSL errors. By + Janik Rabe (#895) + - Fix wrong signal emission argument count (#965) + - Documentation (#920). Sync NEWS, scripts (#849) + - Fix Perl detection on MacOS. By Dominyk Tiller (#927) + - Misc fixes. By Jaroslav Škarvada (#981, #982) + +v1.1.1 2018-02-15 The Irssi team + ! Contains all changes from 1.0.7 + - Restore compatibility with OpenSSL < 1.0.2 (#820, #831) + - Fix test compilation on some platforms (#815, #816) + - Fix portability and backwards compatibility of test runner + (#818, #845) + +v1.0.7 2018-02-15 The Irssi team + - Prevent use after free error during the execution of some + commands. Found by Joseph Bisch (GL#17, GL!24). + - Revert netsplit print optimisation due to crashes (#465, #809, + #812, #819, #824, #832). + - Fix use after free when SASL messages are received in + unexpected order (GL#26, GL!33). + - Fix null pointer dereference in the tab completion when an + empty nick is joined (GL#24, GL!31). + - Fix use after free when entering oper password (GL#22, + GL!32). + - Fix null pointer dereference when too many windows are + opened (GL#27, #837). + - Fix out of bounds access in theme strings when the last + escape is incomplete. Credit to Oss-Fuzz (#842). + - Fix out of bounds write when using negative counts on window + resize (GL#25, GL#29, #836). + - Minor help correction. By William Jackson (#834). + +v1.1.0 2018-01-15 The Irssi team + ! Warning. Irssi is broken and will crash with OpenSSL < 1.0.2 + due to openssl/openssl commit + 5b4b9ce976fce09a7a92e2f25b91a1635cb840fe + * Colour is now re-set when reaching a comma, matching mIRC + behaviour (#742, #740, #790) + * Irssi now shows the initial nick and name on first start + (#785, #786) + * lynx is no longer required to run autogen.sh (#81, #781) + * The command history no longer permits wrapping around (#686) + * /foreach now correctly sends arguments as commands, stopping + you from embarassing AMSGs (#659) + * /server does not connect to servers anymore, use /server + connect to change servers (#559, #649). + * The net_ip_compare API function is now deprecated, and the + previously deprecated net_connect has been removed. By Will + Storey (#770). + + Add an option to ignore all channels or ignore all queries + using /set activity_hide_targets. By Jari Matilainen (#612, + #779) + + Add a startup warning if the TERM var is wrong inside + tmux/screen (#726) + + Add option to hide certain levels from the textbuffer using + /window hidelevel (#746, #808) + + Irssi now has its first unit test (for mode parsing). By + Will Storey (#793) + + Added access to global command history when using window + history, and a binding to erase entries from the command + history (erase_history_entry) (#762) + + -alternate_nick is now available as a network specific + property. By Paul Townsend (#120, #771) + + On FreeBSD, Irssi now supports Capsicum sandbox (/capsicum + enter). By Edward Tomasz Napierala (#735, #755, #772) + + Filenames (directories) ending with a / now tab-complete + (#741) + + UTF-8 should now work in regular expressions when using + GRegex (the default) (#636, #653) + + Nicks are now properly escaped on completion. By Oscar + Linderholm (#693, #709) + + /server add -port now works. By Jari Matilainen (#703) + + Add a setting key_timeout to make key sequences + automatically re-set when not finished (#644, #645) + + Warn users about expired client certificates, as servers may + refuse them (#211, #627) + + Add a new net_start_ssl function for StartTLS. This is + available from ABI 8 and can be used by protocol modules + (#615, #622). + + The %# code is now stored in the textbuffer, so for example + web scripts can make use of it (#626) + + Add new setting break_wide which can be used to enable + breaking of wide characters (for east-asian + users). Originally from FreeBSD ports. (#625) + + Add fuzzing code (#610, #620, #701, #713) + - Netsplits show properly again (#812) + - Do not error on blank lines when using /exec -o. By Fabian + Kurz (FS#902, #805) + - Detect used nickname as reported by server. By Alexandre + Morignot (#219, #804) + - Prevent use after free error during the execution of some + commands. Found by Joseph Bisch. (GL#17, GL!24) + - Fix MODE parameter parsing when colon was used at a place + Irssi didn't expect (#601, #766) + - Fixed code to compile with + -Werror=declaration-after-statement (#795) + - Clang-format is now supported for git-clang-format (#784) + - Fix use after free when changing the network of + hilights. Reported by Rui Mathias. (#787, #788) + - Fix positioning error when tab-completing non-ascii + strings. (#752, #754) + - In-development issues (#750, #751) + - Clarify Alis in /help list (#699, #712) + - Improve /lastlog performance from O(N^2) to O(N) (#715) + - Fix a segfault on "script destroyed" signal. By Stephen + Oberholtzer (#660, #661). + - Fix early ISON error (#596, #647) + - Documentation improvements. By Paolo Martini (#639). + By Tristan Pepin (#731). By Paul Townsend (#684, #736). + By Will Storey (#777) + - Minor cleanups (#590). By Edward Tomasz Napierala (#734, + #738) + - Fix space issue in glib-2.0.m4 (#621) + +v1.0.6 2018-01-07 The Irssi team + ! Note: Code and aliases using `$($'-like constructs are no + longer supported due to issue GL#18. Sorry about the + inconvenience. + - Fix invalid memory access when reading hilight configuration + (#787, #788). + - Fix null pointer dereference when the channel topic is set + without specifying a sender (GL#20, GL!25). + - Fix return of random memory when using incomplete escape + codes (GL#21, GL!26). + - Fix heap buffer overflow when completing certain strings + (GL#19, GL!27). + - Fix return of random memory when using an incomplete + variable argument (GL#18, GL!28). + +v1.0.5 2017-10-23 The Irssi team + - Fix missing -sasl_method '' in /NETWORK (#718, #719). + - Fix incorrect restoration of term state when hitting SUSP + inside screen (#737, #733). + - Fix out of bounds read when compressing colour + sequences. Found by Hanno Böck (GL#12, GL!18). + - Fix use after free condition during a race condition when + waiting on channel sync during a rejoin (GL#13, GL!19). + - Fix null pointer dereference when parsing certain malformed + CTCP DCC messages (GL#14, GL!20). + - Fix crash due to null pointer dereference when failing to + split messages due to overlong nick or target (GL#15, GL!21). + - Fix out of bounds read when trying to skip a safe channel ID + without verifying that the ID is long enough (GL#16, GL!22). + - Fix return of random memory when inet_ntop failed (#769). + - Minor statusbar help update. By Robert Bisewski (#758, + #763). + +v1.0.4 2017-07-07 The Irssi team + - Fix null pointer dereference when parsing invalid timestamp (GL#10, + GL!15). Reported by Brian 'geeknik' Carpenter. + - Fix use-after-free condition when removing nicks from the internal + nicklist (GL#11, GL!16). Reported by Brian 'geeknik' Carpenter. + - Fix incorrect string comparison in DCC file names (#714). + - Fix regression in Irssi 1.0.3 where it would claim "Invalid time '-1'" + (#716, #722). + - Fix a bug when using \n to separate lines with expand_escapes (#723). + - Retain screen output on improper exit, to better see any error + messages (#287, #721). + - Minor help update (#729). + +v1.0.3 2017-06-06 The Irssi team + ! Regression info in 1.0.3: #716 Warnings on start up: invalid time '-1' + - Fix out of bounds read when scanning expandos (GL!11). + - Fix invalid memory access with quoted filenames in DCC + (GL#8, GL!12). + - Fix null-pointer dereference on DCC without address (GL#9, GL!13). + - Improve integer overflow handling. Originally reported by + oss-fuzz#525 (#706). + - Improve nicklist performance from O(N^2) to O(N) (#705). + - Fix initial screen redraw delay. By Stephen Oberholtzer + (#680, bdo#856201). + - Fix incorrect reset of true colours when resetting background. (#711). + - Fix missing -notls option in /SERVER. By Jari Matilainen (#117, #702). + - Fix minor history glitch on overcounter (#462, #685). + - Improved OpenSSL detection at compile time. By Rodrigo Rebello (#677). + - Improved NetBSD Terminfo detection. By Maya Rashish (#694, #698). + - Add missing syntax info for COMPLETION (#687, #688). + - Minor typo correction in help. By Michael Hansen (#707). + +v1.0.2 2017-03-10 The Irssi team + ! Warning. Irssi is broken on GLib 2.46 (bgo#755496) + - Prevent some null-pointer crashes (GL!9). + - Fix compilation with OpenSSL 1.1.0 (#628, #597). + - Correct dereferencing of already freed server objects during + output of netjoins. Found by APic (GL!10, GL#7). + - Fix in command arg parser to detect missing arguments in tail place + (#652, #651). + - Fix regression that broke incoming DCC file transfers (#667, #656). + - Fix issue with escaping \ in evaluated strings (#669, #520). + +v1.0.1 2017-02-03 The Irssi team + - Fix Perl compilation in object dir. By Martijn Dekker (#602, #623). + - Disable EC cryptography on Solaris to fix build (#604, #598). + - Fix incorrect HELP SERVER example (#606, #519). + - Correct memory leak in /OP and /VOICE. By Tim Konick (#608). + - Fix regression that broke second level completion (#613, #609). + - Correct missing NULL termination in perl_parse. By Hanno Böck (#619). + - Sync broken mail.pl script (#624, #607). + - Prevent a memory leak during the processing of the SASL + response (GL!8, GL#5) + +v1.0.0 2017-01-03 The Irssi team + * Removed --disable-ipv6 (#408). * /connect Network now aborts with an error if no servers have been - added to that network. + added to that network (#443). * /dcc commands now use quotes around spaces consistently. - + irssiproxy can now forward all tags through a single port. - + irssiproxy can also listen on unix sockets. - + send channel -botcmds immediately when no mask is specified (#175). + * bell_beeps was removed (#524, #565). + * Switch to GRegex instead of regex.h (#412). + + irssiproxy can now forward all tags through a single + port. By Lukas Mai (mauke, #425). + + irssiproxy can also listen on unix sockets. By Lukas Mai (#427). + + send channel -botcmds immediately when no mask is specified (#175, #399). + the kill buffer now remembers consecutive kills. New bindings were added: yank_next_cutbuffer and append_next_kill + By Todd A. Pratt (#353, #414, #455) + connections will avoid looking up IPv6 addresses if the machine does not have an IPv6 address assigned (exact behaviour is implementation - defined). + defined, #410). + Fix potential crash if scripts insert undef values into the completion - list. - + Paste warning is now also shown on pasting overlong lines. + list (#413). + + Paste warning is now also shown on pasting overlong + lines. By Manish Goregaokar (#426). + autolog_ignore_targets and activity_hide_targets learn a new syntax tag/* and * to ignore whole networks or everything. - + /hilight got a -matchcase flag to hilight case sensitively (#421). + By Jari Matilainen (vague666, #437) + + /hilight got a -matchcase flag to hilight case + sensitively. By Thibault B (isundil, #421, #476). + Always build irssi with TLS support. + Rename SSL to TLS in the code and add -tls_* versions of the -ssl_* options to /CONNECT and /SERVER, but make sure the -ssl_* options continue @@ -32,16 +779,16 @@ v0.8.21-head 2016-xx-xx The Irssi team values like this: Start by downloading the certificate from a given IRC server: - $ openssl s_client -connect chat.freenode.net:6697 < /dev/null 2>/dev/null | \ - openssl x509 > freenode.cert + $ openssl s_client -connect irc.example.net:6697 < /dev/null 2>/dev/null | \ + openssl x509 > example.cert Find the value for -tls_pinned_cert: - $ openssl x509 -in freenode.cert -fingerprint -sha256 -noout + $ openssl x509 -in example.cert -fingerprint -sha256 -noout Find the value for -tls_pinned_pubkey: - $ openssl x509 -in freenode.cert -pubkey -noout | \ + $ openssl x509 -in example.cert -pubkey -noout | \ openssl pkey -pubin -outform der | \ openssl dgst -sha256 -c | \ tr a-z A-Z @@ -54,45 +801,87 @@ v0.8.21-head 2016-xx-xx The Irssi team does not rely on the libval library. It is causing a lot of troubles for our downstream maintainers. + + /names and $[...] now uses utf8 string operations. By Xavier + G. (#40, #411, #471, #480). + + New setting completion_nicks_match_case (#488). + + /channel /server /network now support modify subcommand. By + Jari Matilainen (#338, #498). + + Irssi::signal_remove now works with coderefs. By Tom Feist (shabble, #512). + + /script reset got an -autorun switch (#540, #538). + + cap_toggle can now be called from Perl, and fields + cap_active and cap_supported can be inspected (#542). + + Make it possible to disable empty line completion. By Lauri + Tirkkonen (lotheac, #574). + + New option sasl_disconnect_on_failure to disconnect when + SASL log-in failed (#514). - IP addresses are no longer stored when resolve_reverse_lookup is used. - - /names and $[...] now uses utf8 string operations (#40, #411). - - Removed broken support for curses. + - Removed broken support for curses (#521). + - Removed broken dummy mode (#526). + - Fix terminal state after suspend (#450, #452). + - Improve Perl library path detection (#479, #132). + - Reconnect now works on unix connections (#493). + - Fix completion warnings (#125, #496, FS#124). + - Fix a crash in the --more-- item (#501). + - Fix a display issue in /unignore (#517, bdo#577202). + - Fix a crash in some netsplits (#529, #500). + - Fix crashes with some invalid config (#550, #551, #563, #564, #587, #581, #570). + - Add support for SASL Fragmentation. By Kenny Root (kruton, #506). + - Improve netsplit dumping (#420, #465). + - Improve responsibility under DCC I/O strain (#578, #159). + - Fix query nick change on open (#580, #586). + - Correct a few help texts. + +v0.8.21 2017-01-03 The Irssi team + - Correct a NULL pointer dereference in the nickcmp function found by + Joseph Bisch (GL#1) + - Correct an out of bounds read in certain incomplete control codes + found by Joseph Bisch (GL#2) + - Correct an out of bounds read in certain incomplete character + sequences found by Hanno Böck and independently by J. Bisch (GL#3) + - Correct an error when receiving invalid nick message (GL#4, #466) v0.8.20 2016-09-16 The Irssi team - Correct the name of an emitted sasl signal (#484) - Correct the prototype for the 'message private' signal (#515) - Corrections in away and hilight help text (#477, #518) - - /squery and /servlist commands have been restored. + - /squery and /servlist commands have been restored (#461). - Where Irssi would previously only report "System error" on connect, - it will now try harder to retrieve the system error message. + it will now try harder to retrieve the system error message (#467). - Fixed issue with +channels not working properly (#533) - - Fixed crash in optchan when item has no server (#485) + - Fixed crash in optchan when item has no server (#485, bdo#826525) - Fixed random remote crash in the nicklist handling (#529) - Fixed remote crash due to incorrect bounds checking on formats, reported by Gabriel Campana and Adrien Guinet from Quarkslab. v0.8.19 2016-03-23 The Irssi team + ! If your cursor keys stopped working, try this first: `/bind + meta-O key meta2' - Fixed regression when joining and parting channels on IRCnet (#435) - - Fixed SASL EXTERNAL (#432) + - Fixed SASL EXTERNAL. By Mantas Mikulėnas (grawity, #432) - Fixed regression when not using SASL (#438) - - Fixed incorrect SSL disconnects when using SSL from modules/scripts - (#439) + - Fixed incorrect SSL disconnects when using SSL from modules/scripts. + By Will Storey (horgh, #439) - Fixed regression where proxy_string could not be configured or - certain file transfers could not be accepted (#445) - - Fixed storing layout of !channels (#183) - - Fixed restoration of bracketed paste mode on quit (#449) + certain file transfers could not be accepted (#445, #446) + - Fixed storing layout of !channels (#183, #405) + - Fixed restoration of bracketed paste mode on quit (#449, #457) - Make the usage of meta-O for cursor keys configurable with /set term_appkey_mode off + (#430, #459) v0.8.18 2016-02-13 The Irssi team * Modules will now require to define a + void MODULENAME ## _abicheck(int *version) + method to ensure that they are compiled against the correct Irssi version. * The signature of "message private" has been changed to + 5: server, message, nick, address, target + in order to support "self messages". Module authors should implement this change if they are using this signal. * Removing networks will now remove all attached servers and channels @@ -105,12 +894,14 @@ v0.8.18 2016-02-13 The Irssi team effect for anyone given that it has been unsupported for several years. + CAP SASL PLAIN login is now supported natively. + Paste bracket markers can be requested from terminal with + /set paste_use_bracketed_mode on + + "Self messages" generated by some bouncers can now be received in the proper window. + Try to split long lines on spaces to avoid words being splitted. Adds - a new option: 'split_line_on_space' which defaults to on. - + Add setting hilight_nick_matches_everywhere (#56). + a new option: `split_line_on_space' which defaults to on. + + Add setting `hilight_nick_matches_everywhere' (#56). + The config parser is more robust and prints out better diagnostics on incorrect config files. + Ctrl+^ (FS#721) and Ctrl+J can now be bound. diff --git a/README.md b/README.md index d6577fdf..bfe521d3 100644 --- a/README.md +++ b/README.md @@ -1,109 +1,74 @@ -# Irssi +# [Irssi](https://irssi.org) -[![Build Status](https://travis-ci.org/irssi/irssi.svg?branch=master)](https://travis-ci.org/irssi/irssi) +![Build Status](https://github.com/irssi/irssi/workflows/Check%20Irssi/badge.svg?branch=master) -Irssi is a modular chat client that is most commonly known for its -text mode user interface, but 80% of the code isn't text mode -specific. We have a working but currently unmaintained GTK2 frontend -called xirssi. Irssi comes with IRC support built in, and there are -third party [ICB](https://github.com/jperkin/irssi-icb), +Irssi is a modular text mode chat client. It comes with IRC support +built in, and there are third party +[ICB](https://github.com/jperkin/irssi-icb), [SILC](http://www.silcnet.org/), [XMPP](http://cybione.org/~irssi-xmpp/) (Jabber), -[PSYC](https://github.com/electric-blue/irssyc) and +[PSYC](http://about.psyc.eu/Irssyc) and [Quassel](https://github.com/phhusson/quassel-irssi) protocol modules available. -## Installation +![irssi](https://user-images.githubusercontent.com/5665186/32180643-cf127f60-bd92-11e7-8aa2-882313ce1d8e.png) -See the `INSTALL` file. +## [Download information](https://irssi.org/download/) -## Features +#### Development source installation -So what's so great about Irssi? Here's a list of some features I can -think of currently: +[Ninja](https://ninja-build.org/) 1.8 and [Meson](https://mesonbuild.com/) 0.53 - - **Optional automation** - There's lots of things Irssi does for you - automatically that some people like and others just hate. Things like: - nick completion, creating new window for newly joined channel, creating - queries when msgs/notices are received or when you send a msg, closing - queries when it's been idle for some time, etc. +``` +git clone https://github.com/irssi/irssi +cd irssi +meson Build +ninja -C Build && sudo ninja -C Build install +``` - - **Multiserver friendy** - I think Irssi has clearly the best support - for handling multiple server connections. You can have as many as you - want in as many ircnets as you want. Having several connections in one - server works too, for example when you hit the (ircnet's) 10 - channels/connection limit you can just create another connection and - you hardly notice it. If connection to server is lost, Irssi tries to - connect back until it's successful. Also channels you were joined - before disconnection are restored, even if they're "temporarily - unavailable" because of netsplits, Irssi keeps rejoining back to them. - Also worth noticing - there's not that stupid "server is bound to this - window, if this window gets closed the connection closes" thing that - ircII based clients have. +#### Release source installation - - **Channel automation** - You can specify what channels to join to - immediately after connected to some server or IRC network. After joined - to channel, Irssi can automatically request ops for you (or do - anything, actually) from channel's bots. +* Download [release](https://github.com/irssi/irssi/releases) +* Verify signature +``` +tar xJf irssi-*.tar.xz +cd irssi-* +meson Build +ninja -C Build && sudo ninja -C Build install +``` - - **Window content saving** - Say /LAYOUT SAVE when you've put all the - channels and queries to their correct place, and after restarting - Irssi, the channels will be joined back into windows where they were - saved. +### Requirements - - **Tab completing anything** - You can complete lots of things with tab: - nicks, commands, command -options, file names, settings, text format - names, channels and server names. There's also an excellent /msg - completion that works transparently with multiple IRC networks. - Completing channel nicks is also pretty intelligent, it first goes - through the people who have talked to you recently, then the people who - have talked to anyone recently and only then it fallbacks to rest of - the nicks. You can also complete a set of words you've specified, for - example homepage changes it to your actual home page URL. +- [glib-2.32](https://wiki.gnome.org/Projects/GLib) or greater +- [openssl](https://www.openssl.org/) +- [perl-5.8](https://www.perl.org/) or greater (for perl support) +- terminfo or ncurses (for text frontend) - - **Excellent logging** - You can log any way you want and as easily or - hard as you want. With autologging Irssi logs everything to specified - directory, one file per channel/nick. ircII style /WINDOW LOG ON is - also supported. There's also the "hard way" of logging - /LOG command - which lets you specify exactly what you wish to log and where. Log - rotating is supported with all the different logging methods, you can - specify how often you want it to rotate and what kind of time stamp to - use. +#### See the [INSTALL](INSTALL) file for details - - **Excellent ignoring** - You can most probably ignore anything any way - you want. Nick masks, words, regular expressions. You can add - exceptions to ignores. You can ignore other people's replies in - channels to nicks you have ignored. You can also specify that the - specific ignores work only in specific channel(s). +## [Documentation](https://irssi.org/documentation/) - - **Lastlog and scrollback handling** - /LASTLOG command has some new - features: -new option checks only lines that came since you last did - /LASTLOG command, -away option checks new lines since you last went - away. Regular expression matches work also, of course. Going to some - wanted place at scrollback has always been hard with non-GUI clients. A - search command that jumps around in scrollback in GUI-style is still - missing from Irssi, but there's something that's almost as good as it. - /LASTLOG always shows timestamps when the line was printed, even if you - didn't have timestamps on. Now doing /SB GOTO jumps - directly to the position in scrollback you wanted. Great feature when - you want to browse a bit of the discussion what happened when someone - said your name (as seen in awaylog) or topic was changed (/last - -topics) +* [New users guide](https://irssi.org/New-users/) +* [Questions and Answers](https://irssi.org/documentation/qna/) +* Check the built-in `/HELP`, it has all the details on command syntax -## Files +## [Themes](https://irssi-import.github.io/themes/) - - The `docs/` directory contains several documents: - - `startup-HOWTO.txt` - new users should read this - - `manual.txt` - manual I started writing but didn't get it very far :) - - `perl.txt` - Perl scripting help - - `formats.txt` - How to use colors, etc. with irssi - - `faq.txt` - Frequently Asked Questions - - `special_vars.txt` - some predefined $variables you can use with irssi +## [Scripts](https://scripts.irssi.org/) -## Bugs / Suggestions +## [Modules](https://irssi.org/modules/) -See the `TODO` file, http://bugs.irssi.org and the GitHub issues if it is -already listed in there; if not, open an issue on GitHub or send a mail to -[staff@irssi.org](mailto:staff@irssi.org). +## [Security information](https://irssi.org/security/) -You can also contact the Irssi developers in #irssi on freenode. +Please report security issues to staff@irssi.org. Thanks! + +## [Bugs](https://github.com/irssi/irssi/issues) / Suggestions / Contributing + +Check the GitHub issues if it is already listed in there; if not, open +an issue on GitHub or send a mail to [staff@irssi.org](mailto:staff@irssi.org). + +Irssi is always looking for developers. Feel free to submit patches through +GitHub pull requests. + +You can also contact the Irssi developers in +[#irssi](https://irssi.org/support/irc/) on irc.libera.chat. diff --git a/autogen.sh b/autogen.sh deleted file mode 100755 index 946f1ebb..00000000 --- a/autogen.sh +++ /dev/null @@ -1,67 +0,0 @@ -#!/bin/sh -# Run this to generate all the initial makefiles, etc. - -PKG_NAME="Irssi" - -srcdir=`dirname $0` -test -z "$srcdir" && srcdir=. - -if test ! -f $srcdir/configure.ac; then - echo -n "**Error**: Directory \`$srcdir\' does not look like the" - echo " top-level $PKG_NAME directory" - exit 1 -fi - -# create help files -echo "Creating help files..." -perl syntax.pl - -echo "Creating ChangeLog..." -git log > $srcdir/ChangeLog -if test "$?" -ne 0; then - echo "**Error**: ${PKG_NAME} Autogen must be run in a git clone, cannot proceed." - exit 1 -fi - -files=`echo docs/help/in/*.in|sed -e 's,docs/help/in/Makefile.in ,,' -e 's,docs/help/in/,!,g' -e 's/\.in /.in ?/g'` -cat docs/help/in/Makefile.am.gen|sed "s/@HELPFILES@/$files/g"|sed 's/?/\\?/g'|tr '!?' '\t\n' > docs/help/in/Makefile.am - -files=`echo $files|sed 's/\.in//g'` -cat docs/help/Makefile.am.gen|sed "s/@HELPFILES@/$files/g"|sed 's/?/\\?/g'|tr '!?' '\t\n' > docs/help/Makefile.am - -# .html -> .txt with lynx or elinks -echo "Documentation: html -> txt..." -if type lynx >/dev/null 2>&1 ; then - LC_ALL=en_IE.utf8 lynx -dump docs/faq.html|perl -pe 's/^ *//; if ($_ eq "\n" && $state eq "Q") { $_ = ""; } elsif (/^([QA]):/) { $state = $1 } elsif ($_ ne "\n") { $_ = " $_"; };' > docs/faq.txt -elif type elinks >/dev/null 2>&1 ; then - elinks -dump docs/faq.html|perl -pe 's/^ *//; if ($_ eq "\n" && $state eq "Q") { $_ = ""; } elsif (/^([QA]):/) { $state = $1 } elsif ($_ ne "\n") { $_ = " $_"; };' > docs/faq.txt -elif type links >/dev/null 2>&1 ; then - links -dump docs/faq.html|perl -pe 's/^ *//; if ($_ eq "\n" && $state eq "Q") { $_ = ""; } elsif (/^([QA]):/) { $state = $1 } elsif ($_ ne "\n") { $_ = " $_"; };' > docs/faq.txt -else - echo "**Error**: No lynx or elinks present" - exit 1 -fi - -if test x$NOCONFIGURE = x && test -z "$*"; then - echo "**Warning**: I am going to run \`configure' with no arguments." - echo "If you wish to pass any to it, please specify them on the" - echo \`$0\'" command line." - echo -fi - -rm -f aclocal.m4 -echo "Running autoreconf ..." -autoreconf -i || exit 1 - -conf_flags="--enable-maintainer-mode" - -if test x$NOCONFIGURE = x; then - echo Running $srcdir/configure $conf_flags "$@" ... - $srcdir/configure $conf_flags "$@" \ - && echo Now type \`make\' to compile $PKG_NAME || exit 1 -else - echo Skipping configure process. -fi - -# make sure perl hashes have correct length -find src/perl -name *.c -o -name *.xs | xargs grep -n hv_store | perl -ne 'if (/"(\w+)",\s*(\d+)/) { print unless $2 == length $1 }' diff --git a/configure.ac b/configure.ac deleted file mode 100644 index bf87f5aa..00000000 --- a/configure.ac +++ /dev/null @@ -1,653 +0,0 @@ -AC_INIT(irssi, 0.8.21-head) -AC_CONFIG_SRCDIR([src]) -AC_CONFIG_AUX_DIR(build-aux) -AC_PREREQ(2.50) - -AC_CONFIG_HEADERS([irssi-config.h]) -AC_CONFIG_MACRO_DIR([m4]) -AM_INIT_AUTOMAKE([1.9 no-define foreign]) - -AM_SILENT_RULES([yes]) - -AM_MAINTAINER_MODE - -AC_PROG_CC -AC_PROG_CPP -AM_PROG_LIBTOOL - -AC_PATH_PROG(sedpath, sed) -AC_PATH_PROG(perlpath, perl) - -AC_CHECK_HEADERS(unistd.h dirent.h sys/ioctl.h sys/resource.h) - -# check posix headers.. -AC_CHECK_HEADERS(sys/socket.h sys/time.h sys/utsname.h regex.h) - -AC_SYS_LARGEFILE - -AC_ARG_WITH(socks, -[ --with-socks Build with socks support], - if test x$withval = xno; then - want_socks=no - else - want_socks=yes - fi, - want_socks=no) - -AC_ARG_WITH(textui, -[ --without-textui Build without text frontend], - if test x$withval = xno; then - want_textui=no - else - want_textui=yes - fi, - want_textui=yes) - -AC_ARG_WITH(bot, -[ --with-bot Build irssi-bot], - if test x$withval = xno; then - want_irssibot=no - else - want_irssibot=yes - fi, - want_irssibot=no) - -AC_ARG_WITH(proxy, -[ --with-proxy Build irssi-proxy], - if test x$withval = xno; then - want_irssiproxy=no - else - want_irssiproxy=yes - fi, - want_irssiproxy=no) - -AC_ARG_WITH(modules, -[ --with-modules Specify what modules to build in binary], - if test x$withval != xyes -a x$withval != xno; then - build_modules="$withval" - fi) - -if test "x$prefix" != "xNONE"; then - prefix=`eval echo $prefix` - PERL_MM_PARAMS="INSTALLDIRS=perl INSTALL_BASE=$prefix" - perl_set_use_lib=yes - - perl_prefix_note=yes -fi - -AC_ARG_WITH(perl-staticlib, -[ --with-perl-staticlib Specify that we want to link perl libraries - statically in irssi, default is no], - if test x$withval = xno; then - want_staticperllib=no - else - want_staticperllib=yes - fi, - want_staticperllib=no) - - -AC_ARG_WITH(perl-lib, -[ --with-perl-lib=[perl|site|vendor|DIR] Specify where to install the - Perl libraries for irssi, default is site], - if test "x$withval" = xyes; then - want_perl=yes - elif test "x$withval" = xno; then - want_perl=no - elif test "x$withval" = xperl; then - want_perl=yes - perl_prefix_note=no - PERL_MM_PARAMS="INSTALLDIRS=perl" - perl_set_use_lib=no - elif test "x$withval" = xsite; then - want_perl=yes - perl_prefix_note=no - PERL_MM_PARAMS="" - perl_set_use_lib=no - elif test "x$withval" = xvendor; then - want_perl=yes - perl_prefix_note=no - if test -z "`$perlpath -v|grep '5\.0'`"; then - PERL_MM_PARAMS="INSTALLDIRS=vendor" - else - PERL_MM_PARAMS="INSTALLDIRS=perl PREFIX=`$perlpath -e 'use Config; print $Config{prefix}'`" - fi - perl_set_use_lib=no - else - want_perl=yes - perl_prefix_note=no - PERL_MM_PARAMS="INSTALLDIRS=perl LIB=$withval" - perl_set_use_lib=yes - fi, - want_perl=yes) - -AC_ARG_WITH(perl, -[ --with-perl[=yes|no|module] Build with Perl support - also specifies - if it should be built into main irssi binary - (static, default) or as module], - if test x$withval = xyes; then - want_perl=static - elif test x$withval = xstatic; then - want_perl=static - elif test x$withval = xmodule; then - want_perl=module - else - want_perl=no - fi, - want_perl=static) - -AC_ARG_ENABLE(true-color, -[ --enable-true-color Build with true color support in terminal], - if test x$enableval = xno ; then - want_truecolor=no - else - want_truecolor=yes - fi, - want_truecolor=no) - -dnl ** -dnl ** just some generic stuff... -dnl ** - -dnl * OS specific options -case "$host_os" in - hpux*) - CFLAGS="$CFLAGS -D_XOPEN_SOURCE_EXTENDED" - ;; - *) - ;; -esac - - -AC_SEARCH_LIBS([socket], [network socket]) - -AC_SEARCH_LIBS([inet_addr], [nsl]) - -dnl * gcc specific options -if test "x$ac_cv_prog_gcc" = "xyes"; then - CFLAGS="$CFLAGS -Wall" -fi - -AC_CHECK_TYPE(socklen_t, , - [AC_DEFINE([socklen_t], [int], [Define to 'int' if doesn't define.])], [ -AC_INCLUDES_DEFAULT -#ifdef HAVE_SYS_SOCKET_H -# include -#endif -]) - -AC_CHECK_SIZEOF(int) -AC_CHECK_SIZEOF(long) -AC_CHECK_SIZEOF(long long) -AC_CHECK_SIZEOF(off_t) - -if test $ac_cv_sizeof_off_t = 8; then - offt_64bit=yes -else - offt_64bit=no -fi - -if test x$ac_cv_sizeof_off_t = x$ac_cv_sizeof_long; then - # try to use unsigned long always first - AC_DEFINE_UNQUOTED(PRIuUOFF_T, "lu") - AC_DEFINE(UOFF_T_LONG) -elif test x$ac_cv_sizeof_off_t = x$ac_cv_sizeof_int; then - # next try int - AC_DEFINE_UNQUOTED(PRIuUOFF_T, "u") - AC_DEFINE(UOFF_T_INT) -elif test x$ac_cv_sizeof_off_t = x$ac_cv_sizeof_long_long; then - # and finally long long - AC_DEFINE_UNQUOTED(PRIuUOFF_T, "llu") - AC_DEFINE(UOFF_T_LONG_LONG) -else - AC_ERROR([Couldn't find integer type for off_t]) -fi - -dnl ** -dnl ** check for socks -dnl ** - -if test "x$want_socks" = "xyes"; then - AC_CHECK_LIB(socks, connect, [ - AC_DEFINE(HAVE_SOCKS,, Build with socks support) - LIBS="$LIBS -lsocks" - AC_CHECK_HEADER(socks.h, [ - AC_DEFINE(HAVE_SOCKS_H) - CFLAGS="$CFLAGS -DSOCKS" - AC_MSG_RESULT(["socks5 library found, building with it"]) - ], [ - AC_MSG_RESULT(["socks4 library found, building with it"]) - CFLAGS="$CFLAGS -Dconnect=Rconnect -Dgetsockname=Rgetsockname -Dgetpeername=Rgetpeername -Dbind=Rbind -Daccept=Raccept -Dlisten=Rlisten -Dselect=Rselect" - ]) - ]) -fi - -dnl ** -dnl ** OpenSSL checks -dnl ** -AC_CHECK_LIB([ssl], [SSL_library_init]) - -dnl ** -dnl ** fe-text checks -dnl ** - -for try in 1 2; do - if test $try = 1; then - glib_modules=gmodule - else - echo "*** trying without -lgmodule" - glib_modules= - fi - AM_PATH_GLIB_2_0(2.16.0,,, $glib_modules) - if test "$GLIB_LIBS"; then - if test $glib_modules = gmodule; then - AC_DEFINE(HAVE_GMODULE) - have_gmodule=yes - fi - break - fi -done - -if test -z "$GLIB_LIBS"; then - echo - echo "*** If you don't have GLIB, you can get it from ftp://ftp.gtk.org/pub/glib/" - echo "*** We recommend you get the latest stable GLIB 2 version." - echo "*** Compile and install it, and make sure pkg-config finds it," - echo "*** by adding the path where the .pc file is located to PKG_CONFIG_PATH" - echo -n "*** Or alternatively install your distribution's package" - if test -f /etc/debian_version; then - echo : - echo "*** sudo apt-get install libglib2.0-dev" - elif test -f /etc/redhat-release; then - echo " (glib2-devel)" - else - echo . - fi - echo - - AC_ERROR([GLIB is required to build irssi.]) -fi - -LIBS="$LIBS $GLIB_LIBS -lssl -lcrypto" - -dnl ** -dnl ** curses checks -dnl ** - -if test "x$want_textui" != "xno"; then - - TEXTUI_NO_LIBS="$LIBS" - LIBS= - AC_SEARCH_LIBS([setupterm], [tinfo ncursesw ncurses], [want_textui=yes], [ - AC_ERROR(Terminfo not found - install libncurses-dev or ncurses-devel package) - want_textui="no, Terminfo not found" - ]) - - TEXTUI_LIBS="$LIBS" - AC_SUBST(TEXTUI_LIBS) - LIBS="$TEXTUI_NO_LIBS" - -fi - -dnl ** -dnl ** perl checks -dnl ** - -if test "$want_perl" != "no"; then - AC_MSG_CHECKING(for working Perl support) - - if test -z "$perlpath"; then - perl_check_error="perl binary not found" - else - PERL_CFLAGS=`$perlpath -MExtUtils::Embed -e ccopts 2>/dev/null` - fi - - if test "x$ac_cv_prog_gcc" = "xyes" -a -z "`echo $host_os|grep 'bsd\|linux'`"; then - dnl * several systems have Perl compiled with native compiler - dnl * but irssi is being compiled with GCC. Here we try to - dnl * fix those command line options a bit so GCC won't - dnl * complain about them. Normally there's only few options - dnl * that we want to keep: - dnl * -Ddefine -Uundef -I/path -fopt -mopt - PERL_CFLAGS=`echo $PERL_CFLAGS | $perlpath -pe 's/^(.* )?-@<:@^DUIfm@:>@@<:@^ @:>@+/\1/g; s/^(.* )?\+@<:@^ @:>@+/\1/g'` - - PERL_EXTRA_OPTS="CCCDLFLAGS=\"-fPIC\"" - AC_SUBST(PERL_EXTRA_OPTS) - fi - - if test -z "$PERL_CFLAGS"; then - if test -n "$perl_check_error"; then - perl_check_error="Error getting perl CFLAGS" - fi - AC_MSG_RESULT([not found, building without Perl]) - want_perl=no - else - PERL_LDFLAGS=`$perlpath -MExtUtils::Embed -e ldopts 2>/dev/null` - - dnl * remove all database stuffs - dnl * nsl is already in ldflags - dnl * libc is of course linked without needing -lc - dnl * -rdynamic must not be in LIBADD line - for word in -ldb -ldbm -lndbm -lgdbm -lc -rdynamic; do - PERL_LDFLAGS=`echo $PERL_LDFLAGS | $sedpath -e "s/$word //" -e "s/$word$//"` - done - - case "$host_os" in - linux*) - PERL_LDFLAGS=`echo $PERL_LDFLAGS | $sedpath -e 's/-lposix //' -e 's/-lposix$//'` - ;; - hpux*) - if test "x$ac_cv_prog_gcc" = "xyes"; then - PERL_CFLAGS=`echo $PERL_CFLAGS | $sedpath -e 's/-Ae //' -e 's/-Ae$//'` - PERL_LDFLAGS=`echo $PERL_LDFLAGS | $sedpath -e 's/-Ae //' -e 's/-Ae$//'` - fi - ;; - *) - ;; - esac - - dnl * check that perl's ldflags actually work - echo "#include " > conftest.c - echo "#include " >> conftest.c - echo "int main(){perl_alloc(); return 0;}" >> conftest.c - $CC $CFLAGS $PERL_CFLAGS conftest.c -o conftest $LDFLAGS $PERL_LDFLAGS 2> perl.error.tmp > /dev/null - if test ! -s conftest -a "x$ignore_perl_errors" = "x"; then - perl_check_error="Error linking with perl libraries: $PERL_LDFLAGS: `cat perl.error.tmp`" - AC_MSG_RESULT([error linking with perl libraries, building without Perl]) - want_perl=no - fi - - rm -f perl.error.tmp - fi - - if test "x$want_perl" != "xno"; then - AC_MSG_RESULT(ok) - - if test "x$want_perl" = "xstatic"; then - dnl * building with static perl support - dnl * all PERL_LDFLAGS linking is done in fe-text - PERL_LINK_FLAGS="$PERL_LDFLAGS" - PERL_LINK_LIBS="../perl/libperl_core_static.la" - PERL_FE_LINK_LIBS="../perl/libfe_perl_static.la" - PERL_LDFLAGS= - AC_DEFINE(HAVE_STATIC_PERL) - - dnl * build only static library of perl module - perl_module_lib= - perl_module_fe_lib= - perl_static_lib=libperl_core_static.la - perl_static_fe_lib=libfe_perl_static.la - else - dnl * build dynamic library of perl module - perl_module_lib=libperl_core.la - perl_module_fe_lib=libfe_perl.la - perl_static_lib= - perl_static_fe_lib= - fi - - if test "x$want_staticperllib" = "xyes"; then - PERL_MM_PARAMS="$PERL_MM_PARAMS LINKTYPE=static" - PERL_LINK_LIBS="$PERL_LINK_LIBS ../perl/common/blib/arch/auto/Irssi/Irssi.a ../perl/irc/blib/arch/auto/Irssi/Irc/Irc.a ../perl/ui/blib/arch/auto/Irssi/UI/UI.a ../perl/textui/blib/arch/auto/Irssi/TextUI/TextUI.a" - PERL_STATIC_LIBS=1 - else - PERL_STATIC_LIBS=0 - fi - - # remove any prefix from PERL_MM_OPT - PERL_MM_OPT=`perl -MText::ParseWords -e 'sub qu{$_=shift;s{^(.*?)=(.*)$}{($a,$b)=($1,$2);$b=~s/"/\\\\"/g;qq{$a="$b"}}ge if /@<:@\s"@:>@/;$_} local $,=" "; print map qu($_), grep !/^(INSTALL_BASE|PREFIX)=/, shellwords(@ARGV)' "$PERL_MM_OPT"` - # figure out the correct @INC path - we'll need to do this - # through MakeMaker since it's difficult to get it right - # otherwise. - $perlpath -MExtUtils::MakeMaker -e 'WriteMakefile(NAME => "test", MAKEFILE => "Makefile.test", FIRST_MAKEFILE => "/dev/null", NO_META => 1, NO_MYMETA => 1);' $PERL_MM_PARAMS >/dev/null - echo 'show-INSTALLDIRS:' >> Makefile.test - echo ' @echo $(INSTALLDIRS)' >> Makefile.test - perl_INSTALLDIRS=`$am_make -s -f Makefile.test show-INSTALLDIRS` - if test "x$perl_INSTALLDIRS" = "xsite"; then - perl_library_dir="site default" - perl_INSTALL_VAR=INSTALLSITEARCH - elif test "x$perl_INSTALLDIRS" = "xvendor"; then - perl_library_dir="vendor default" - perl_INSTALL_VAR=INSTALLVENDORARCH - else - perl_library_dir="module default" - perl_INSTALL_VAR=INSTALLARCHLIB - fi - echo 'show-ARCHLIB:' >> Makefile.test - echo ' @echo $('"$perl_INSTALL_VAR"')' >> Makefile.test - perl_use_lib=`$am_make -s -f Makefile.test show-ARCHLIB` - rm -f Makefile.test - if test "x$perl_set_use_lib" = "xyes"; then - if $perlpath -e 'exit ! grep $_ eq $ARGV@<:@0@:>@, grep /^\//, @INC' "$perl_use_lib"; then - perl_library_dir="other path in @INC" - perl_set_use_lib=no - else - perl_library_dir="prepends to @INC with /set perl_use_lib" - PERL_USE_LIB="$perl_use_lib" - fi - fi - - AC_SUBST(perl_module_lib) - AC_SUBST(perl_static_lib) - AC_SUBST(perl_module_fe_lib) - AC_SUBST(perl_static_fe_lib) - - AC_SUBST(PERL_LINK_FLAGS) - AC_SUBST(PERL_LINK_LIBS) - AC_SUBST(PERL_FE_LINK_LIBS) - - AC_SUBST(PERL_LDFLAGS) - AC_SUBST(PERL_CFLAGS) - - AC_SUBST(PERL_USE_LIB) - AC_SUBST(PERL_MM_OPT) - AC_SUBST(PERL_MM_PARAMS) - AC_SUBST(PERL_STATIC_LIBS) - fi -fi - -dnl ** check what we want to build -AM_CONDITIONAL(BUILD_TEXTUI, test "$want_textui" = "yes") -AM_CONDITIONAL(BUILD_IRSSIBOT, test "$want_irssibot" = "yes") -AM_CONDITIONAL(BUILD_IRSSIPROXY, test "$want_irssiproxy" = "yes") -AM_CONDITIONAL(HAVE_PERL, test "$want_perl" != "no") - -# move LIBS to PROG_LIBS so they're not tried to be used when linking eg. perl libraries -PROG_LIBS=$LIBS -LIBS= -AC_SUBST(PROG_LIBS) - -dnl ** -dnl ** Keep all the libraries here so each frontend doesn't need to -dnl ** keep track of them all -dnl ** -dnl ** (these could be made configurable) - -CHAT_MODULES="irc" -irc_MODULES="dcc flood notifylist" -if test -n "$build_modules"; then - irc_MODULES="$irc_MODULES $build_modules" -fi - -dnl **************************************** - -AC_SUBST(CHAT_MODULES) -AC_SUBST(irc_MODULES) - -CORE_LIBS="../core/libcore.a ../lib-config/libirssi_config.a" -FE_COMMON_LIBS="" - -CHAT_LIBS="" -for c in $CHAT_MODULES; do - module_inits="" - module_deinits="" - fe_module_inits="" - fe_module_deinits="" - CHAT_LIBS="$CHAT_LIBS ../$c/lib$c.a ../$c/core/lib${c}_core.a" - if test -f $srcdir/src/fe-common/$c/module.h; then - FE_COMMON_LIBS="$FE_COMMON_LIBS../fe-common/$c/libfe_common_$c.a " - fi - for s in `eval echo \\$${c}_MODULES`; do - CHAT_LIBS="$CHAT_LIBS ../$c/$s/lib${c}_$s.a" - module_inits="$module_inits ${c}_${s}_init();" - module_deinits="${c}_${s}_deinit(); $module_deinits" - if test -f $srcdir/src/fe-common/$c/$s/module.h; then - FE_COMMON_LIBS="$FE_COMMON_LIBS../fe-common/$c/$s/libfe_${c}_$s.a " - fe_module_inits="$fe_module_inits fe_${c}_${s}_init();" - fe_module_deinits="fe_${c}_${s}_deinit(); $fe_module_deinits" - fi - done - - mkdir -p src/$c - file="src/$c/$c.c" - echo "/* this file is automatically generated by configure - don't change */" > $file - echo "void ${c}_core_init(void); void ${c}_core_deinit(void);" >> $file - if test -n "$module_inits"; then - echo "$module_inits" | $sedpath -e 's/()/(void)/g' -e 's/ /void /g' >> $file - echo "$module_deinits" | $sedpath -e 's/ *$//' -e 's/()/(void)/g' -e 's/ /void /g' -e 's/^/void /' >> $file - fi - echo "void ${c}_init(void) { ${c}_core_init(); $module_inits }" >> $file - echo "void ${c}_deinit(void) { $module_deinits ${c}_core_deinit(); }" >> $file - - if test -f $srcdir/src/fe-common/$c/module.h; then - mkdir -p src/fe-common/$c - file="src/fe-common/$c/${c}-modules.c" - echo "/* this file is automatically generated by configure - don't change */" > $file - if test -n "$fe_module_inits"; then - echo "$fe_module_inits" | $sedpath -e 's/()/(void)/g' -e 's/ /void /g' >> $file - echo "$fe_module_deinits" | $sedpath -e 's/ *$//' -e 's/()/(void)/g' -e 's/ /void /g' -e 's/^/void /' >> $file - fi - echo "void fe_${c}_modules_init(void) { $fe_module_inits }" >> $file - echo "void fe_${c}_modules_deinit(void) { $fe_module_deinits }" >> $file - fi -done - -FE_COMMON_LIBS="$FE_COMMON_LIBS../fe-common/core/libfe_common_core.a" - -dnl ** common libraries needed by frontends -COMMON_NOUI_LIBS="$CHAT_LIBS $CORE_LIBS" -COMMON_LIBS="$FE_COMMON_LIBS $COMMON_NOUI_LIBS" -AC_SUBST(COMMON_NOUI_LIBS) -AC_SUBST(COMMON_LIBS) - -if test "x$want_truecolor" = "xyes"; then - AC_DEFINE([TERM_TRUECOLOR], [], [true color support in terminal]) -else - want_truecolor=no -fi - -AH_TEMPLATE(HAVE_GMODULE) -AH_TEMPLATE(HAVE_SOCKS_H, [misc..]) -AH_TEMPLATE(HAVE_STATIC_PERL) -AH_TEMPLATE(PRIuUOFF_T, [printf()-format for uoff_t, eg. "u" or "lu" or "llu"]) -AH_TEMPLATE(UOFF_T_INT, [What type should be used for uoff_t]) -AH_TEMPLATE(UOFF_T_LONG) -AH_TEMPLATE(UOFF_T_LONG_LONG) - -AC_CONFIG_FILES([ -Makefile -src/Makefile -src/core/Makefile -src/irc/Makefile -src/irc/core/Makefile -src/irc/dcc/Makefile -src/irc/notifylist/Makefile -src/irc/proxy/Makefile -src/irc/flood/Makefile -src/fe-common/Makefile -src/fe-common/core/Makefile -src/fe-common/irc/Makefile -src/fe-common/irc/dcc/Makefile -src/fe-common/irc/notifylist/Makefile -src/fe-none/Makefile -src/fe-text/Makefile -src/lib-config/Makefile -src/perl/Makefile -src/perl/common/Makefile.PL -src/perl/irc/Makefile.PL -src/perl/ui/Makefile.PL -src/perl/textui/Makefile.PL -scripts/Makefile -scripts/examples/Makefile -docs/Makefile -docs/help/Makefile -docs/help/in/Makefile -irssi-config -]) - -AC_OUTPUT - -dnl ** for building from objdir -old_dir=`pwd` && cd $srcdir && whole_dir=`pwd` && cd $old_dir -if test "x$old_dir" != "x$whole_dir"; then - $LN_S $srcdir/irssi-version.h irssi-version.h - if test "x$want_perl" != "xno"; then - subdirfiles="" - for i in $whole_dir/src/perl/common $whole_dir/src/perl/irc $whole_dir/src/perl/ui $whole_dir/src/perl/textui; do - subdirfiles=`echo $subdirfiles $i/typemap $i/module.h $i/*.pm $i/*.xs` - done - for file in $whole_dir/src/perl/module.h $subdirfiles; do - link=`echo $file|$sedpath "s?$whole_dir/??"` - rm -f $link - $LN_S $file $link - done - fi -fi - -echo - -echo "Building text frontend ........... : $want_textui" -echo "Building irssi bot ............... : $want_irssibot" -echo "Building irssi proxy ............. : $want_irssiproxy" -if test "x$have_gmodule" = "xyes"; then - echo "Building with module support ..... : yes" -else - echo "Building with module support : NO!! /LOAD will not work!" - echo " - You're missing gmodule (comes with glib) for some reason," - echo " or it doesn't work in your system." -fi - -if test "x$want_perl" = "xstatic"; then - echo "Building with Perl support ....... : static (in irssi binary)" -elif test "x$want_perl" = "xmodule"; then - echo "Building with Perl support ....... : module" -else - if test -z "$perl_check_error"; then - echo "Building with Perl support ....... : no" - else - echo "Building with Perl support ....... : NO!" - echo " - $perl_check_error" - if test -f /etc/debian_version; then - echo " - Try: sudo apt-get install libperl-dev" - elif test -f /etc/redhat-release; then - echo " - Try installing perl-devel" - fi - fi -fi - -if test "x$want_perl" != "xno" -a "x$perl_mod_error" != "x"; then - echo " - NOTE: Perl support will be compiled statically to irssi, not as" - echo " a module as requested. Reason:" - echo " $perl_mod_error" - - if test -f /etc/debian_version; then - echo " - Try: sudo apt-get install libperl-dev" - fi -fi - -if test "x$want_perl" != "xno"; then - echo "Perl library directory ........... : ($perl_library_dir - $perl_use_lib)" - if test "x$perl_prefix_note" = "xyes"; then - echo " - NOTE: This was automatically set to the same directory you gave with" - echo " --prefix. If you want the perl libraries to install to their 'correct'" - echo " path, you'll need to give --with-perl-lib=site option to configure." - echo " Anyway, installing perl to this directory should work just as well." - fi -fi -echo "Install prefix ................... : $prefix" - -echo - -echo "Building with 64bit DCC support .. : $offt_64bit" -echo "Building with true color support.. : $want_truecolor" - -echo -echo "If there are any problems, read the INSTALL file." diff --git a/docs/Makefile.am b/docs/Makefile.am deleted file mode 100644 index 861a2ca4..00000000 --- a/docs/Makefile.am +++ /dev/null @@ -1,17 +0,0 @@ -man_MANS = \ - irssi.1 - -doc_DATA = \ - design.txt \ - formats.txt \ - manual.txt \ - faq.html \ - faq.txt \ - perl.txt \ - signals.txt \ - special_vars.txt \ - startup-HOWTO.html - -EXTRA_DIST = $(doc_DATA) $(man_MANS) - -SUBDIRS = help diff --git a/docs/New-users.html b/docs/New-users.html new file mode 100644 index 00000000..496f319e --- /dev/null +++ b/docs/New-users.html @@ -0,0 +1,110 @@ + +

New users guide

+
+

New to IRC

+

Internet Relay Chat was created in 1988 and has hardly changed. It can be used to exchange text messages (one message = single line) with other people, either privately (called query, PM, private message, MSG) or in a room (channel). Pictures are shared by uploading them to a temporary host like https://pomf.lain.la/ and then pasting the HTTP links. Code snippets or longer texts are shared by pasting them to a Pastebin like https://paste.opensuse.org/ and then sharing the HTTP link.

+

IRC does not have message history. You can only receive replies while your computer is turned on and connected to the channel you want to follow. Some people run their IRC programs on remote servers for that reason.

+

IRC is organised into networks. Each network consists of many servers. It (mostly) does not matter which server you connect to as long as it belongs to the network you want to use. Irssi supports connections to many networks at the same time.

+

Each network contains many channels, rooms that are often dedicated to discussing a specific topic. You can find many channels on https://netsplit.de/ or using a search engine with the keyword “IRC”. Irssi supports joining many channels at the same time.

+

There is a rather large IRC network catering to free and open-source software and peer directed projects at https://libera.chat/ and a smaller one at https://www.oftc.net/ – many free software projects still have support channels on these IRC networks (although some have moved to Matrix or proprietary platforms like Discord).

+
+
+

First start

+

After (compiling and) installing Irssi, to start it, open a shell (Terminal) and type:

+
irssi
+
+
+

You should be greeted by a blinking cursor behind [(status)]. You are now in the status window of Irssi. Window is the Irssi name for what you might nowadays call a “Web browser tab”.

+

If you’re confused about what you are seeing on the Irssi screen, you can find an annotated screenshot of it at User interface.

+

If you want, you can pick a nick name (handle) that will be shown to others reading your messages now, by typing

+
/set nick whatyouwant
+
+
+

Each command or message can be sent by pressing Enter. Commands in Irssi start with a /. If there is no /, then the line that you wrote will be sent as a message to the channel that you have open, for everyone to see.

+
+

Leaving

+

Type /quit to get out of Irssi.

+
+
+
+

Connecting to a network

+

Irssi comes with some predefined networks. You can see the current list of networks by typing

+
/network
+
+
+

(the list will be shown in your status window)

+

To connect to one of the networks in the list, type /connect networkname, for example:

+
/connect liberachat
+
+
+

You should see several messages scroll by. After a while, you should be connected to the Libera Chat network.

+
+

Attention

+

Irssi version 1.2 or older may be lacking the liberachat network entry. See https://github.com/shabble/irssi-docs/wiki/liberachat for how to add it.

+
+
+

Nickname registration

+

Many IRC networks (but not all) offer a way to register a user account. Sometimes (but not on all networks) the account registration also includes reserving a nick for you. How to register also differs by network. Some channels only allow users with registered accounts to join them, so it may be very important for you to register a user account.

+

User accounts are always specific to a network.

+

For the Libera Chat network, you can find instructions how to register and set up your account with Irssi on https://github.com/shabble/irssi-docs/wiki/liberachat#configure-sasl-automated-log-in

+
+
+
+

Joining a channel

+

Once you are connected to a network, you can join channels by typing /join #channelname, for example:

+
/join #irssi
+
+
+

Now, a new window will open and you can send messages to the channel.

+
+

Changing windows

+

You can change between windows using the Ctrl+n or Ctrl+p keys, or–if your terminal is configured properly–using Alt+1, Alt+2, … See bind -list for a list of all default key bindings.

+
+
+

Removing clutter

+

By default, Irssi shows when someone joins or leaves a channel. These messages can waste a lot of lines and obscure the actual chat. To hide them, type

+
/window hidelevel +joins +parts +quits
+
+
+

To get them back

+
/window hidelevel -joins -parts -quits
+
+
+

If you want to hide them by default, /set window_default_hidelevel hidden joins parts quits

+
+
+
+

Adding a new network

+

If you want to join a network that is not there, you first need to find at least one server of that network. Let’s say you have found the room #hackint on netsplit.de and want to join it. Then you can find that the server is irc.hackint.org, port 6697, SSL (TLS) on. To add it to Irssi, use the commands:

+
/network add hackint
+/server add -tls -network hackint irc.hackint.org 6697
+
+
+

Then, you can connect to the newly added network with

+
/connect hackint
+
+
+
+

Multiple networks

+

If you are connected to multiple networks, you can change which one you are “talking” to (which one to send commands) by using the Ctrl+x key in the status window.

+
+
+
+

On-line help

+

Most /commands have a help page, you can read it with

+
/help commandname
+
+
+

or on-line.

+

The settings that can be changed with /SET are described on Settings Documentation – the settingshelp script can be used to read it from within /help

+
+
+

About Scripts

+

You can enhance your Irssi by installing scripts. Many Perl scripts written by other Irssi users can be found on https://scripts.irssi.org/

+

Most of them should be compatible with Irssi 1.4 (but some may not, also see the Full Change log for some incompatible ones)

+
+
+

About Themes

+

Irssi’s look can be thoroughly changed with themes. Many themes created by other Irssi users can be found on https://themes.irssi.org/

+

If you want to modify the look of Irssi yourself, the default theme which can be found in your ~/.irssi folder is a good starting point. It also has a few comments explaining what some of the abstracts are used for

+
\ No newline at end of file diff --git a/docs/New-users.txt b/docs/New-users.txt new file mode 100644 index 00000000..5c5a268c --- /dev/null +++ b/docs/New-users.txt @@ -0,0 +1,193 @@ +# New users guide # + +## New to IRC ## + +Internet Relay Chat was created in 1988 and has hardly changed. It can be used +to exchange text messages (one message = single line) with other people, either +privately (called query, PM, private message, MSG) or in a room (channel). +Pictures are shared by uploading them to a temporary host like [1]https:// +pomf.lain.la/ and then pasting the HTTP links. Code snippets or longer texts +are shared by pasting them to a Pastebin like [2]https://paste.opensuse.org/ +and then sharing the HTTP link. + +IRC does not have message history. You can only receive replies while your +computer is turned on and connected to the channel you want to follow. Some +people run their IRC programs on remote servers for that reason. + +IRC is organised into networks. Each network consists of many servers. It +(mostly) does not matter which server you connect to as long as it belongs to +the network you want to use. Irssi supports connections to many networks at the +same time. + +Each network contains many channels, rooms that are often dedicated to +discussing a specific topic. You can find many channels on [3]https:// +netsplit.de/ or using a search engine with the keyword “IRC”. Irssi supports +joining many channels at the same time. + +There is a rather large IRC network catering to free and open-source software +and peer directed projects at [4]https://libera.chat/ and a smaller one at [5] +https://www.oftc.net/ – many free software projects still have support channels +on these IRC networks (although some have moved to Matrix or proprietary +platforms like Discord). + +## First start ## + +After (compiling and) installing Irssi, to start it, open a shell (Terminal) +and type: + +irssi + +You should be greeted by a blinking cursor behind [(status)]. You are now in +the status window of Irssi. Window is the Irssi name for what you might +nowadays call a “Web browser tab”. + +If you’re confused about what you are seeing on the Irssi screen, you can find +an annotated screenshot of it at [6]User interface. + +If you want, you can pick a nick name (handle) that will be shown to others +reading your messages now, by typing + +/set nick whatyouwant + +Each command or message can be sent by pressing Enter. Commands in Irssi start +with a /. If there is no /, then the line that you wrote will be sent as a +message to the channel that you have open, for everyone to see. + +### Leaving ### + +Type /quit to get out of Irssi. + +## Connecting to a network ## + +Irssi comes with some predefined networks. You can see the current list of +networks by typing + +/network + +(the list will be shown in your status window) + +To connect to one of the networks in the list, type /connect networkname, for +example: + +/connect liberachat + +You should see several messages scroll by. After a while, you should be +connected to the Libera Chat network. + +Attention + +Irssi version 1.2 or older may be lacking the liberachat network entry. See [7] +https://github.com/shabble/irssi-docs/wiki/liberachat for how to add it. + +### Nickname registration ### + +Many IRC networks (but not all) offer a way to register a user account. +Sometimes (but not on all networks) the account registration also includes +reserving a nick for you. How to register also differs by network. Some +channels only allow users with registered accounts to join them, so it may be +very important for you to register a user account. + +User accounts are always specific to a network. + +For the Libera Chat network, you can find instructions how to register and set +up your account with Irssi on [8]https://github.com/shabble/irssi-docs/wiki/ +liberachat#configure-sasl-automated-log-in + +## Joining a channel ## + +Once you are connected to a network, you can join channels by typing /join # +channelname, for example: + +/join #irssi + +Now, a new window will open and you can send messages to the channel. + +### Changing windows ### + +You can change between windows using the Ctrl+n or Ctrl+p keys, or–if your +terminal is configured properly–using Alt+1, Alt+2, … See [9]bind -list for a +list of all default key bindings. + +### Removing clutter ### + +By default, Irssi shows when someone joins or leaves a channel. These messages +can waste a lot of lines and obscure the actual chat. To hide them, type + +/window hidelevel +joins +parts +quits + +To get them back + +/window hidelevel -joins -parts -quits + +If you want to hide them by default, /set window_default_hidelevel hidden joins +parts quits + +## Adding a new network ## + +If you want to join a network that is not there, you first need to find at +least one server of that network. Let’s say you have found the room [10]# +hackint on netsplit.de and want to join it. Then you can find that the [11] +server is irc.hackint.org, port 6697, SSL (TLS) on. To add it to Irssi, use the +commands: + +/network add hackint +/server add -tls -network hackint irc.hackint.org 6697 + +Then, you can connect to the newly added network with + +/connect hackint + +### Multiple networks ### + +If you are connected to multiple networks, you can change which one you are +“talking” to (which one to send commands) by using the Ctrl+x key in the status +window. + +## On-line help ## + +Most /commands have a help page, you can read it with + +/help commandname + +or [12]on-line. + +The settings that can be changed with /SET are described on [13]Settings +Documentation – the settingshelp [14]script can be used to read it from within +/help + +## About Scripts ## + +You can enhance your Irssi by installing scripts. Many Perl scripts written by +other Irssi users can be found on [15]https://scripts.irssi.org/ + +Most of them should be compatible with Irssi 1.4 (but some may not, also see +the Full Change log for some incompatible ones) + +## About Themes ## + +Irssi’s look can be thoroughly changed with themes. Many themes created by +other Irssi users can be found on [16]https://themes.irssi.org/ + +If you want to modify the look of Irssi yourself, the default theme which can +be found in your ~/.irssi folder is a good starting point. It also has a few +comments explaining what some of the abstracts are used for + + +References: + +[1] https://pomf.lain.la/ +[2] https://paste.opensuse.org/ +[3] https://netsplit.de/ +[4] https://libera.chat/ +[5] https://www.oftc.net/ +[6] https://irssi.org/User-interface/ +[7] https://github.com/shabble/irssi-docs/wiki/liberachat +[8] https://github.com/shabble/irssi-docs/wiki/liberachat#configure-sasl-automated-log-in +[9] https://irssi.org/documentation/help/bind_-list/ +[10] https://netsplit.de/channels/details.php?room=%23hackint&net=hackint +[11] https://netsplit.de/servers/?net=hackint +[12] https://irssi.org/documentation/help/ +[13] https://irssi.org/documentation/settings/ +[14] https://irssi.org/New-users/#about-scripts +[15] https://scripts.irssi.org/ +[16] https://themes.irssi.org/ diff --git a/docs/capsicum.txt b/docs/capsicum.txt new file mode 100644 index 00000000..d2ad920c --- /dev/null +++ b/docs/capsicum.txt @@ -0,0 +1,31 @@ +Capsicum is a lightweight OS capability and sandbox framework provided +by FreeBSD. When built with Capsicum support - which is the default under +FreeBSD - Irssi can enter a Capsicum capability mode (a sandbox), greatly +limiting possible consequences of a potential security hole in Irssi +or the libraries it depends on. + +To make Irssi enter capability mode on startup, add + +capsicum = "yes"; +awaylog_file = "~/irclogs/away.log"; + +to your ~/.irssi/config in the settings/core section, and restart the +client. Alternatively you can enter it "by hand", using the +"/capsicum enter" command. From the security point of view it's strongly +preferable to use the former method, to avoid establishing connections +without the sandbox protection; the "/capsicum" command is only intended +for experimentation, and in cases where you need to do something that's not +possible in capability mode - run scripts, for example - before continuing. + +There is no way to leave the capability mode, apart from exiting Irssi. +When running in capability mode, there are certain restrictions - Irssi +won't be able to access any files outside the directory pointed to by +capsicum_irclogs_path (which defaults to ~/irclogs/). If you change +the path when already in capability mode it won't be effective until +you restart Irssi. Capability mode also makes it impossible to use +the "/save" command. + +Currently there is no way to use custom SSL certificates. As a workaround +you can establish connections and enter the capability mode afterwards +using the "/capsicum enter" command. + diff --git a/docs/design.html b/docs/design.html new file mode 100644 index 00000000..e4f9bb06 --- /dev/null +++ b/docs/design.html @@ -0,0 +1,165 @@ + +

Design

+

Irssi’s hierarchy is something like this:

+ +

+        sub1 sub2
+           \ /
+      xxx  IRC       COMMON ICQ  yyy
+       |    |           |    |    |
+       '----+-----:-----+----+----'
+                  |
+                 GUI (gtk/gnome, qt/kde, text, none)
+                  |
+        sub1 sub2 |
+           \ /    |
+      xxx  IRC    |  COMMON ICQ  yyy
+       '----+-----+-----+----+----'
+                  |
+              COMMON UI
+                  |
+        sub1 sub2 |
+           \ /    |
+      xxx  IRC    |    ICQ  yyy
+       |    |     |     |    |
+       '----+-----+-----+----'
+                  |
+                CORE
+                /
+       lib-config
+
+
+ +

(IRC, ICQ, xxx and yyy are chat protocols ..)

+ +

(sub1 and sub2 are submodules of IRC module, like DCC and flood protect)

+ +

Chat protocols and frontends are kept in separate modules. Common UI +and GUI modules also have the common parts which don’t know anything +about the chat protocols. This should allow implementing modules to +whatever chat protocols and with whatever frontends easily.

+ +

Signals

+ +

Communication between different modules are done with “signals”. They are +not related to UNIX signals in any way, you could more like think of them +as “events” - which might be a better name for them, but I don’t really +want to change it anymore :)

+ +

So, you send signal with signal_emit() and it’s sent to all modules that +have grabbed it by calling signal_add() in their init function. For +example:

+ +
signal_emit("mysignal", 1, "hello");
+
+ +

Sends a “mysignal” function with one argument “hello” - before that, you +should have grabbed the signal somewhere else with:

+ +
static void sig_mysignal(const char *arg1)
+{
+  /* arg1 contains "hello" */
+}
+
+signal_add("mysignal", (SIGNAL_FUNC) sig_mysignal);
+
+ +

There are three different signal_add() functions which you can use to +specify if you want to grab the signal first, “normally” or last. You can +also stop the signal from going any further.

+ +

Emitting signal with it’s name creates a small overhead since it has to +look up the signal’s numeric ID first, after which it looks up the signal +structure. This is done because if you call a signal really often, +it’s faster to find it with it’s numeric ID instead of the string. You +can use signal_get_uniq_id() macro to convert the signal name into ID - +you’ll have to do this only once! - and use signal_emit_id() to emit the +signal. Don’t bother to do this unless your signal is sent (or could be +sent) several times in a second.

+ +

See src/core/signals.h for definition of the signal function, and +signals.txt for a list of signals.

+ +

lib-config

+ +

Irssi depends on this for reading and saving configuration. +(created by me for irssi)

+ +

CORE module

+ +

Provides some functionality that all other modules can use:

+
    +
  • signal handling
    • +
  • keeping list of settings
    • +
  • keeping list of /commands
    • +
  • keeping track of loaded modules
    • +
  • networking functions (with nonblocking connects, IPv6 support)
    • +
  • handles connecting to servers
    • +
  • raw logging of server’s input/output data
    • +
  • /EVAL support
    • +
  • fgets() like function line_split() without any maximum line limits
    • +
  • command line parameter handling
    • +
  • miscellaneous useful little functions
    • +
  • handles logging
    • +
+ +

COMMON UI module

+ +
    +
  • knows basics about windows and window items (=channels, queries, ..)
    • +
  • printtext() - parsing texts and feeding it for GUI to print.
    • +
  • themes
    • +
  • translation tables
    • +
  • text hilighting
    • +
  • command history
    • +
  • user interface (/commands) for CORE’s functionality
    • +
+ +

GUI modules

+ +
    +
  • all the rest of the functionality needed for a working client.
    • +
+ +

IRC module

+ +
    +
  • CORE +
      +
    • IRC specific /commands
      • +
    • flood protecting commands sent to server
      • +
    • creating IRC masks based on nick/address for bans, ignores, etc.
      • +
    • keeps list of channels, nicks, channel modes, bans, etc.
      • +
    • keeps list of servers, server settings, irc networks, +server reconnections and irc network splits
      • +
    • redirection of commands’ replies
      • +
    • lag detection
      • +
    • ctcp support and flood protection
      • +
    • Handles ignoring people
      • +
    +
    • +
  • DCC +
      +
    • DCC chat, send and get
      • +
    +
    • +
  • FLOOD +
      +
    • detects private or channel flooding and sends “flood” signal
      • +
    • automatic ignoring when flooding
      • +
    +
    • +
  • NOTIFYLIST +
      +
    • handles notifylist
      • +
    +
    • +
+ +

IRC UI module

+ +
    +
  • placing channels and queries in windows
    • +
  • nick completion
    • +
  • printing infomation of some events
    • +
diff --git a/docs/design.txt b/docs/design.txt index 3f372829..6888f211 100644 --- a/docs/design.txt +++ b/docs/design.txt @@ -1,150 +1,139 @@ +Design - Irssi's hierarchy is something like this: +Irssi’s hierarchy is something like this: + + sub1 sub2 + \ / + xxx IRC COMMON ICQ yyy + | | | | | + '----+-----:-----+----+----' + | + GUI (gtk/gnome, qt/kde, text, none) + | + sub1 sub2 | + \ / | + xxx IRC | COMMON ICQ yyy + '----+-----+-----+----+----' + | + COMMON UI + | + sub1 sub2 | + \ / | + xxx IRC | ICQ yyy + | | | | | + '----+-----+-----+----' + | + CORE + / + lib-config - sub1 sub2 - \ / - xxx IRC COMMON ICQ yyy - |____|___________|____|____| - | - GUI (gtk/gnome, qt/kde, text, none) - | - sub1 sub2 | - \ / | - xxx IRC | COMMON ICQ yyy - |____|_____|_____|____|____| - | - COMMON UI - | - sub1 sub2 | - \ / | - xxx IRC | ICQ yyy - |____|_____|_____|____| - | - CORE - / - lib-config +(IRC, ICQ, xxx and yyy are chat protocols ..) +(sub1 and sub2 are submodules of IRC module, like DCC and flood protect) - (IRC, ICQ, xxx and yyy are chat protocols ..) - (sub1 and sub2 are submodules of IRC module, like DCC and flood protect) +Chat protocols and frontends are kept in separate modules. Common UI and GUI +modules also have the common parts which don’t know anything about the chat +protocols. This should allow implementing modules to whatever chat protocols +and with whatever frontends easily. +Signals - Chat protocols and frontends are kept in separate modules. Common UI - and GUI modules also have the common parts which don't know anything - about the chat protocols. This should allow implementing modules to - whatever chat protocols and with whatever frontends easily. +Communication between different modules are done with “signals”. They are not +related to UNIX signals in any way, you could more like think of them as +“events” - which might be a better name for them, but I don’t really want to +change it anymore :) - ** Signals +So, you send signal with signal_emit() and it’s sent to all modules that have +grabbed it by calling signal_add() in their init function. For example: - Communication between different modules are done with "signals". They are - not related to UNIX signals in any way, you could more like think of them - as "events" - which might be a better name for them, but I don't really - want to change it anymore :) +signal_emit("mysignal", 1, "hello"); - So, you send signal with signal_emit() and it's sent to all modules that - have grabbed it by calling signal_add() in their init function. For - example: +Sends a “mysignal” function with one argument “hello” - before that, you should +have grabbed the signal somewhere else with: - signal_emit("mysignal", 1, "hello"); +static void sig_mysignal(const char *arg1) +{ + /* arg1 contains "hello" */ +} - Sends a "mysignal" function with one argument "hello" - before that, you - should have grabbed the signal somewhere else with: +signal_add("mysignal", (SIGNAL_FUNC) sig_mysignal); - static void sig_mysignal(const char *arg1) - { - /* arg1 contains "hello" */ - } +There are three different signal_add() functions which you can use to specify +if you want to grab the signal first, “normally” or last. You can also stop the +signal from going any further. - signal_add("mysignal", (SIGNAL_FUNC) sig_mysignal); +Emitting signal with it’s name creates a small overhead since it has to look up +the signal’s numeric ID first, after which it looks up the signal structure. +This is done because if you call a signal really often, it’s faster to find it +with it’s numeric ID instead of the string. You can use signal_get_uniq_id() +macro to convert the signal name into ID - you’ll have to do this only once! - +and use signal_emit_id() to emit the signal. Don’t bother to do this unless +your signal is sent (or could be sent) several times in a second. - There are three different signal_add() functions which you can use to - specify if you want to grab the signal first, "normally" or last. You can - also stop the signal from going any further. +See src/core/signals.h for definition of the signal function, and signals.txt +for a list of signals. - Emitting signal with it's name creates a small overhead since it has to - look up the signal's numeric ID first, after which it looks up the signal - structure. This is done because if you call a signal _really_ often, - it's faster to find it with it's numeric ID instead of the string. You - can use signal_get_uniq_id() macro to convert the signal name into ID - - you'll have to do this only once! - and use signal_emit_id() to emit the - signal. Don't bother to do this unless your signal is sent (or could be - sent) several times in a second. +lib-config - See src/core/signals.h for definition of the signal function, and - signals.txt for a list of signals. +Irssi depends on this for reading and saving configuration. (created by me for +irssi) +CORE module - ** lib-config +Provides some functionality that all other modules can use: - Irssi depends on this for reading and saving configuration. - (created by me for irssi) + • signal handling + • keeping list of settings + • keeping list of /commands + • keeping track of loaded modules + • networking functions (with nonblocking connects, IPv6 support) + • handles connecting to servers + • raw logging of server’s input/output data + • /EVAL support + • fgets() like function line_split() without any maximum line limits + • command line parameter handling + • miscellaneous useful little functions + • handles logging +COMMON UI module - ** CORE module + • knows basics about windows and window items (=channels, queries, ..) + • printtext() - parsing texts and feeding it for GUI to print. + • themes + • translation tables + • text hilighting + • command history + • user interface (/commands) for CORE’s functionality - Provides some functionality that all other modules can use: - - signal handling - - keeping list of settings - - keeping list of /commands - - keeping track of loaded modules - - networking functions (with nonblocking connects, IPv6 support) - - handles connecting to servers - - raw logging of server's input/output data - - /EVAL support - - fgets() like function line_split() without any maximum line limits - - command line parameter handling - - miscellaneous useful little functions - - handles logging +GUI modules + • all the rest of the functionality needed for a working client. - ** COMMON UI module +IRC module - - knows basics about windows and window items (=channels, queries, ..) - - printtext() - parsing texts and feeding it for GUI to print. - - themes - - translation tables - - text hilighting - - command history - - user interface (/commands) for CORE's functionality + • CORE + □ IRC specific /commands + □ flood protecting commands sent to server + □ creating IRC masks based on nick/address for bans, ignores, etc. + □ keeps list of channels, nicks, channel modes, bans, etc. + □ keeps list of servers, server settings, irc networks, server + reconnections and irc network splits + □ redirection of commands’ replies + □ lag detection + □ ctcp support and flood protection + □ Handles ignoring people + • DCC + □ DCC chat, send and get + • FLOOD + □ detects private or channel flooding and sends “flood” signal + □ automatic ignoring when flooding + • NOTIFYLIST + □ handles notifylist +IRC UI module - ** GUI modules + • placing channels and queries in windows + • nick completion + • printing infomation of some events - - all the rest of the functionality needed for a working client. - - - ** IRC module - - * CORE - - - IRC specific /commands - - flood protecting commands sent to server - - creating IRC masks based on nick/address for bans, ignores, etc. - - keeps list of channels, nicks, channel modes, bans, etc. - - keeps list of servers, server settings, irc networks, - server reconnections and irc network splits - - redirection of commands' replies - - lag detection - - ctcp support and flood protection - - Handles ignoring people - - * DCC - - - DCC chat, send and get - - * FLOOD - - - detects private or channel flooding and sends "flood" signal - - automatic ignoring when flooding - - * NOTIFYLIST - - - handles notifylist - - - ** IRC UI module - - - placing channels and queries in windows - - nick completion - - printing infomation of some events diff --git a/docs/example-cross-android-aarch64.txt b/docs/example-cross-android-aarch64.txt new file mode 100644 index 00000000..caae0383 --- /dev/null +++ b/docs/example-cross-android-aarch64.txt @@ -0,0 +1,47 @@ +[binaries] +ar = 'aarch64-linux-android-ar' +c = 'aarch64-linux-android-clang' +cpp = 'aarch64-linux-android-clang++' +ld = 'aarch64-linux-android-ld' +pkgconfig = '/home/builder/.termux-build/_cache/android-r20-api-24-v3/bin/aarch64-linux-android-pkg-config' +strip = 'aarch64-linux-android-strip' + +;; you have to substitute 5.30.2 with the Perl version, that can be +;; obtained by running ` miniperl -e 'print substr $^V, 1' ` + +perl = ['/home/builder/.termux-build/perl/src/miniperl', '-I/data/data/com.termux/files/usr/lib/perl5/5.30.2/aarch64-android', '-I/data/data/com.termux/files/usr/lib/perl5/5.30.2'] + +[properties] +needs_exe_wrapper = true +c_args = ['-fstack-protector-strong', '-Oz', '-I/data/data/com.termux/files/usr/include'] +cpp_args = ['-fstack-protector-strong', '-Oz', '-I/data/data/com.termux/files/usr/include'] +c_link_args = ['-L/data/data/com.termux/files/usr/lib', '-Wl,-rpath=/data/data/com.termux/files/usr/lib', '-Wl,--enable-new-dtags', '-Wl,--as-needed', '-Wl,-z,relro,-z,now', '-landroid-glob'] +cpp_link_args = ['-L/data/data/com.termux/files/usr/lib', '-Wl,-rpath=/data/data/com.termux/files/usr/lib', '-Wl,--enable-new-dtags', '-Wl,--as-needed', '-Wl,-z,relro,-z,now', '-landroid-glob'] + +;; if you do not have a cross-perl like miniperl available, you have +;; to specify the required options by uncommenting the following +;; properties + +;; you can get the proper values by running the commands on your +;; Android device: + +;; ` perl -V::version: ` +; perl_version = '5.30.2' +;; ` perl -MExtUtils::Embed -o ccopts ` +; perl_ccopts = ['-I/data/data/com.termux/files/usr/include', '-D_LARGEFILE_SOURCE', '-D_FILE_OFFSET_BITS=64', '-I/data/data/com.termux/files/usr/lib/perl5/5.30.2/aarch64-android/CORE'] +;; ` perl -MExtUtils::Embed -o ldopts ` +; perl_ldopts = ['-Wl,-E', '-I/data/data/com.termux/files/usr/include', '-L/data/data/com.termux/files/usr/lib/perl5/5.30.2/aarch64-android/CORE', '-lperl', '-lm', '-ldl'] +;; ` perl -V::archname: ` +; perl_archname = 'aarch64-android' +;; ` perl -V::installsitearch: ` +; perl_installsitearch = '/data/data/com.termux/files/usr/lib/perl5/site_perl/5.30.2/aarch64-android' +;; ` perl -V::installvendorarch: ` +; perl_installvendorarch = '' +;; ` perl -E 'say for @INC' ` +; perl_inc = ['/data/data/com.termux/files/usr/lib/perl5/site_perl/5.30.2/aarch64-android', '/data/data/com.termux/files/usr/lib/perl5/site_perl/5.30.2', '/data/data/com.termux/files/usr/lib/perl5/5.30.2/aarch64-android', '/data/data/com.termux/files/usr/lib/perl5/5.30.2'] + +[host_machine] +cpu_family = 'arm' +cpu = 'aarch64' +endian = 'little' +system = 'android' diff --git a/docs/faq.html b/docs/faq.html index 345060dc..7909b5b4 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -1,7 +1,8 @@ +

Frequently Asked Questions

-

Q: Why doesn’t irssi display colors even when ircii etc. displays them?

+

Q: Why doesn’t irssi display colors even when ircii etc. displays them?

-

A: They force ANSI colors even if terminal doesn’t support them. By default, irssi uses colors only if terminfo/termcap so says. The correct way to fix this would be to change your TERM environment to a value where colors work, like xterm-color or color_xterm (eg. TERM=xterm-color irssi). If this doesn’t help, then use the evil way of /SET term_force_colors ON.

+

A: They force ANSI colors even if terminal doesn’t support them. By default, irssi uses colors only if terminfo/termcap so says. The correct way to fix this would be to change your TERM environment to a value where colors work, like xterm-256color or color_xterm (eg. TERM=xterm-256color irssi). If this doesn’t help, then use the evil way of /SET term_force_colors ON.

Q: How do I easily write text to channel that starts with ‘/’ character?

@@ -53,7 +54,7 @@

Q: Will there be /DETACH-like feature?

-

A: tmux, screen and dtach can be used to do it just fine.

+

A: tmux, screen and dtach can be used to do it just fine.

Q: How do I run scripts automatically at startup?

@@ -69,7 +70,7 @@

Q: How can I have /WHOIS replies to active window?

-

A: You can disable the status window, or do /WINDOW LEVEL -CRAP in it which would also make several other messages show up in active window. You can also use a script.

+

A: You can disable the status window, or do /WINDOW LEVEL -CRAP in it which would also make several other messages show up in active window. You can also use a script.

Q: How do I add the active network to the statusbar

@@ -77,4 +78,4 @@

Q: How to pronounce Irssi?

-

A: Check here

+

A: Check here

diff --git a/docs/faq.txt b/docs/faq.txt new file mode 100644 index 00000000..0fcc156a --- /dev/null +++ b/docs/faq.txt @@ -0,0 +1,124 @@ + Frequently Asked Questions + +Q: Why doesn’t irssi display colors even when ircii etc. displays them? +A: They force ANSI colors even if terminal doesn’t support them. By default, + irssi uses colors only if terminfo/termcap so says. The correct way to fix this + would be to change your TERM environment to a value where colors work, like + xterm-256color or color_xterm (eg. TERM=xterm-256color irssi). If this doesn’t + help, then use the evil way of /SET term_force_colors ON. + +Q: How do I easily write text to channel that starts with ‘/’ character? +A: / /text + +Q: Why doesn’t irssi update my realname (or whatever) after I change it with / + SET realname and reconnect with /RECONNECT or /SERVER? +A: Irssi is trying to be too smart. This will be fixed in future, but for now + you should use /DISCONNECT and /CONNECT. + +Q: I connected to some server which isn’t responding but now irssi tries to + connect back to it all the time! How can I stop it? +A: Two ways. The “good way” to do it is with /DISCONNECT. Check the server tags + first with /SERVER without giving it any parameters, reconnections are those + that have tag starting with “recon” text. So most probably you’re going to do / + DISCONNECT recon-1. The other way is to remove all the reconnections with / + RMRECONNS, easier but may remove some connections you actually wanted to + reconnect (if you used multiple servers..). + +Q: How do I add seconds to timestamp? +A: /FORMAT timestamp {timestamp %%H:%%M:%%S} - and remember to add the trailing + space :) + +Q: Why does irssi say “Irssi: Channel not fully synchronized yet, try again + after a while” when I try to use /BAN etc? +A: Possibly a bug in irssi, or ircd you’re using does something that irssi + didn’t really notice. The new code should make this happen far less often than + before, but one known reason for this is when irssi doesn’t notice that you + were unable to join some channel. Currently however I don’t know of any such + events irssi doesn’t know about. + + Anyway, if this does happen, do /RAWLOG SAVE ~/rawlog soon after joining to + channel, and either try to figure out yourself why irssi didn’t get reply to + WHO request, or open a Github issue with the full log included. Note that the + rawlog is by default only 200 lines and it may not be enough to show all needed + information, so you might want to do /SET rawlog_lines 1000 or so. + + MODE +b still works fine though. + +Q: Where’s the GUI version? +A: There was one on [1]irssi-import/xirssi but it has not been maintained for a + long time. + +Q: How do I autorejoin channels after being kicked? +A: That’s evil and you shouldn’t do it. If you get kicked, you should stay out, + at least until the channel forgot you existed :) Most channels I’ve joined just + ban you if you autorejoin after kick. If you’re joined to channels who kick + people for fun, try changing channels or something. + + Anyway, if you REALLY want to do that, and you understand that you’re doing + evilness, you can use the autorejoin.pl script that comes with irssi. You’ll + still need to specify the channels you wish to rejoin with /SET + autorejoin_channels #chan1 #chan2 ... + +Q: How do I announce that I’m away/back in all channels I’ve joined? Or how do + I change my nick when setting myself away/back? +A: That’s even worse than autorejoin. Who could possibly care every time you + come and go? Many channels will kick you for using this, and I for example have + added several ignores so I’d never need to see these messages. Learn to use / + AWAY command properly and tell its existence to people who don’t know about it. + /WII yournick shows your away reason much better for people who actually want + to know if you’re there or not. + +Q: Why does irssi autojoin on invite by default? +A: The setting is /SET join_auto_chans_on_invite - it’s not the same as regular + autojoin-on-invite, which irssi doesn’t even have. The only channels that are + joined on invite, are the ones you’ve added to config with /CHANNEL ADD -auto. + This is very useful with +i channels when you need to first send an invite + request to bot, or if you get accidentally kicked from channel, the kicker can + invite you back immediately. + + I don’t see any bad side effects with this feature, so it’s ON by default. I + guess someone could start kicking/inviting you all the time but server + connection shouldn’t drop because of that, and you shouldn’t join channels + whose operators are that evil. + +Q: How to make UTF-8 support work with irssi? +A: Make sure your terminal supports UTF-8 (for example, xterm -u8). If you use + screen, you may have to do screen -U. And in Irssi do /SET term_charset utf-8. + (for 0.8.9 and older: /SET term_type utf-8) + +Q: Will there be /DETACH-like feature? +A: [2]tmux, [3]screen and [4]dtach can be used to do it just fine. + +Q: How do I run scripts automatically at startup? +A: Put them into ~/.irssi/scripts/autorun/ directory. Or better would be if you + placed them in ~/.irssi/scripts/ and created symlinks to autorun directory (eg. + cd ~/.irssi/scripts/autorun/ ; ln -s ../script.pl .) + +Q: How do I execute commands automatically at startup? +A: Put them into ~/.irssi/startup file, each command on its own line. The + preceding slash (/) is not necessary. + +Q: How do I easily edit existing topic? +A: /TOPIC + +Q: How can I have /WHOIS replies to active window? +A: You can disable the status window, or do /WINDOW LEVEL -CRAP in it which + would also make several other messages show up in active window. You can also + use a [5]script. + +Q: How do I add the active network to the statusbar +A: Modify the window-line in statusbar section in config file to window = "{sb + $winref:$tag/$T{sbmode $M}}"; + +Q: How to pronounce Irssi? +A: Check [6]here + + + References: + + [1] https://github.com/irssi-import/xirssi + [2] https://tmux.github.io/ + [3] https://www.gnu.org/software/screen/screen.html + [4] https://sourceforge.net/projects/dtach/ + [5] https://dgl.cx/irssi/hack-whois-in-current-window.pl + [6] https://irssi.org/assets/irssi.wav diff --git a/docs/help/Makefile.am.gen b/docs/help/Makefile.am.gen deleted file mode 100644 index abf824b4..00000000 --- a/docs/help/Makefile.am.gen +++ /dev/null @@ -1,12 +0,0 @@ -# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen - -helpdir = $(datadir)/irssi/help - -help_DATA = \ -@HELPFILES@ - -EXTRA_DIST = \ - Makefile.am.gen \ - $(help_DATA) - -SUBDIRS = in diff --git a/docs/help/in/Makefile.am.gen b/docs/help/in/Makefile.am.gen deleted file mode 100644 index 9b0f2aaa..00000000 --- a/docs/help/in/Makefile.am.gen +++ /dev/null @@ -1,5 +0,0 @@ -# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen - -EXTRA_DIST = \ - Makefile.am.gen \ -@HELPFILES@ diff --git a/docs/help/in/admin.in b/docs/help/in/admin.in index 2b6f8b73..acb6e1ae 100644 --- a/docs/help/in/admin.in +++ b/docs/help/in/admin.in @@ -15,7 +15,7 @@ %9Examples:%9 /ADMIN - /ADMIN orwell.freenode.net + /ADMIN irc.libera.chat /ADMIN mike %9See also:%9 INFO diff --git a/docs/help/in/bind.in b/docs/help/in/bind.in index d6151b23..761d971e 100644 --- a/docs/help/in/bind.in +++ b/docs/help/in/bind.in @@ -6,7 +6,8 @@ %9Parameters:%9 -list: Displays a list of all the bindable commands. - -delete: Removes the binding, + -delete: Removes the binding. + -reset: Reset a key to its default binding. A name of the binding and the command to perform; if no parameter is given, the list of bindings will be displayed. @@ -16,13 +17,15 @@ Details: Adds or removes a binding; the binding itself is case-sensitive and may contain as many characters as you want. - Uppercase characters usually indicate that you need to keep the shift-key - pressed to use the binding. + Key bindings are case sensitive so uppercase letters mean you also have + to use the shift key, except for ctrl which does not support shift but + the keys must always be typed in uppercase. %9Examples:%9 /BIND /BIND meta-c /CLEAR + /BIND meta-C /CYCLE /BIND meta-q change_window 16 /BIND -delete meta-y /BIND ^W^C /WINDOW NEW HIDE diff --git a/docs/help/in/cat.in b/docs/help/in/cat.in index 3a3ed32b..370c1796 100644 --- a/docs/help/in/cat.in +++ b/docs/help/in/cat.in @@ -5,15 +5,22 @@ %9Parameters:%9 - The file to display. + -window: Displays the output in the active window. + + The file to display and optionally a position to seek in the file, + in bytes. %9Description:%9 - Displays the contents of the specified file into the active window. + Displays the contents of the specified file in the active window if -window + is specified, otherwise to the closest matching window depending on levels. + + The seek position parameter is used internally to display away logs, if + omitted the whole file is shown. %9Examples:%9 - /CAT /etc/network/interfaces + /CAT -window /etc/network/interfaces /CAT /home/mike/resume.txt /CAT contact_details.txt diff --git a/docs/help/in/channel.in b/docs/help/in/channel.in index 86e824c2..d9be8cf5 100644 --- a/docs/help/in/channel.in +++ b/docs/help/in/channel.in @@ -33,12 +33,12 @@ /CHANNEL /CHANNEL LIST - /CHANNEL ADD -auto #irssi Freenode + /CHANNEL ADD -auto #irssi liberachat /CHANNEL ADD -auto #basementcat Quakenet secret_lair - /CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout Freenode + /CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout liberachat /CHANNEL ADD -auto -bots 'Q!TheQBot@CServe.quakenet.org' -botcmd '^MSG Q op #irssi' #irssi Quakenet - /CHANNEL MODIFY -noauto #irssi Freenode - /CHANNEL REMOVE #hideout Freenode + /CHANNEL MODIFY -noauto #irssi liberachat + /CHANNEL REMOVE #hideout liberachat %9Special Example:%9 diff --git a/docs/help/in/clear.in b/docs/help/in/clear.in index d43830dd..3b76a7c9 100644 --- a/docs/help/in/clear.in +++ b/docs/help/in/clear.in @@ -12,8 +12,8 @@ %9Description:%9 - Clears the window of all text; you may use this to clear a windows that - contains sensitive information or has rendered improperly. + Scrolls up the text in the window and fills the window with blank lines; you + may want to use this to make new text start at the top of the window again. -%9See also:%9 REDRAW +%9See also:%9 REDRAW, SCROLLBACK CLEAR diff --git a/docs/help/in/connect.in b/docs/help/in/connect.in index e861ad74..4c6acc90 100644 --- a/docs/help/in/connect.in +++ b/docs/help/in/connect.in @@ -17,6 +17,7 @@ -tls_ciphers: TLS cipher suite preference lists. -tls_pinned_cert: Pinned x509 certificate fingerprint. -tls_pinned_pubkey: Pinned public key fingerprint. + -nocap: Disable CAPREQ during connect -noproxy: Ignores the global proxy configuration. -network: The network this connection belongs to. -host: The hostname you would like to connect from. @@ -34,9 +35,9 @@ %9Examples:%9 - /CONNECT Freenode - /CONNECT -6 Freenode - /CONNECT -4 -! -host staff.irssi.org -network Freenode orwell.freenode.net + /CONNECT liberachat + /CONNECT -6 liberachat + /CONNECT -4 -! -host staff.irssi.org -network liberachat irc.libera.chat /CONNECT irc.irssi.org 6667 WzerT8zq mike %9See also:%9 DISCONNECT, RMRECONNS, SERVER diff --git a/docs/help/in/dcc.in b/docs/help/in/dcc.in index 18a77ee9..2e58c9b1 100644 --- a/docs/help/in/dcc.in +++ b/docs/help/in/dcc.in @@ -27,7 +27,7 @@ and file transfers. If you are behind NAT, or if the firewall is too restrictive, you might - want to try if using the passive parameter resolved your connection + want to try if using the passive parameter resolves your connection problem. You can send files which contain special character or spaces by enclosing diff --git a/docs/help/in/disconnect.in b/docs/help/in/disconnect.in index bd4a4e17..c53b1e60 100644 --- a/docs/help/in/disconnect.in +++ b/docs/help/in/disconnect.in @@ -18,7 +18,7 @@ %9Examples:%9 - /DISCONNECT Freenode I'm off for today, take care! + /DISCONNECT liberachat I'm off for today, take care! /DISCONNECT * Vacation time :D /DISCONNECT diff --git a/docs/help/in/echo.in b/docs/help/in/echo.in index 4ff23730..7f080189 100644 --- a/docs/help/in/echo.in +++ b/docs/help/in/echo.in @@ -5,7 +5,6 @@ %9Parameters:%9 - -current: Displays the output in the active window. -window: Displays the output in the target window. -level: Displays the output with a given message level. @@ -18,7 +17,7 @@ %9Examples:%9 /ECHO 1 + 1 = 2 :D - /ECHO -current Testing the ECHO command + /ECHO Testing the ECHO command /ECHO -window #irssi Special variables such as ${N} will not be expanded. %9See also:%9 CAT, EVAL, EXEC, LEVELS diff --git a/docs/help/in/eval.in b/docs/help/in/eval.in index b2d4b625..c53c6248 100644 --- a/docs/help/in/eval.in +++ b/docs/help/in/eval.in @@ -10,13 +10,23 @@ %9Description:%9 Evaluates the given commands and executes them; you can use internal - variables and separate multiple commands by using the ';' character. + variables and separate multiple commands by using the `;' character. + If the command contains a string with `$', `\' or `;' those characters + need to be escaped: + + `$' -> `$$' + `\' -> `\\' (or even `\\\\', depending on where they are used) + `;' -> `\;' %9Examples:%9 /EVAL echo I am connected to ${S} on ${chatnet} as ${N} /EVAL echo My user privileges are +${usermode}; echo Let's party! + to print `1;2$3\4': + + /EVAL echo 1\;2$$3\\4 + %9References:%9 https://github.com/irssi/irssi/blob/master/docs/special_vars.txt diff --git a/docs/help/in/hash.in b/docs/help/in/hash.in index 32dfc9c7..2d5a355d 100644 --- a/docs/help/in/hash.in +++ b/docs/help/in/hash.in @@ -15,7 +15,7 @@ %9References:%9 - http://www.irssi.org + https://irssi.org https://github.com/irssi %9See also:%9 DIE, KILL, OPER diff --git a/docs/help/in/help.in b/docs/help/in/help.in index 555e20e1..35ab9b75 100644 --- a/docs/help/in/help.in +++ b/docs/help/in/help.in @@ -20,7 +20,7 @@ %9References:%9 - http://www.irssi.org + https://irssi.org https://github.com/irssi %9See also:%9 CONNECT, MSG, NETWORK, SERVER diff --git a/docs/help/in/hilight.in b/docs/help/in/hilight.in index 0726e5e7..49a73a7b 100644 --- a/docs/help/in/hilight.in +++ b/docs/help/in/hilight.in @@ -12,7 +12,7 @@ -full: The text must match the full word. -matchcase: The text must match case. -regexp: The text is a regular expression. - -color: The color the display the highlight in. + -color: The color to display the highlight in. -actcolor: The color to mark the highlight activity in the statusbar. -level: Matches only on the given message level. -network: Matches only on the given network. diff --git a/docs/help/in/ignore.in b/docs/help/in/ignore.in index b0a547c1..26dd63bb 100644 --- a/docs/help/in/ignore.in +++ b/docs/help/in/ignore.in @@ -14,6 +14,8 @@ -network: Ignores only on a specific network. -channels: Ignores only on specific channels. -time: The timeout to automatically remove the ignore. + Accepts units specified in days, hours, minutes, seconds, + milliseconds, or no unit for seconds. The mask, channels and levels to ignore; if no argument is provided, the list of ignores will be displayed. @@ -25,6 +27,10 @@ The special level 'NO_ACT' can be used to ignore activity in the statusbar without actually ignoring the message; this behavior is somewhat special because it is allowed in addition to other ignores for the same target. + The special level 'HIDDEN' can be used to hide matching messages that can + later be revealed using /WINDOW HIDELEVEL -HIDDEN + The special level 'NOHILIGHT' can be used to suppress hilights without actually + ignoring the message. %9Examples:%9 @@ -35,12 +41,15 @@ /IGNORE #irssi ALL -PUBLIC -ACTIONS /IGNORE -replies *!*@*.irssi.org ALL /IGNORE -regexp -pattern (away|gone|back|playing|returned) * ACTIONS + /IGNORE -regexp -pattern (away|gone|back|playing|returned) #channel ACTIONS /IGNORE *zzz* NICKS /IGNORE *afk* NICKS /IGNORE *away* NICKS /IGNORE #irssi NO_ACT JOINS PARTS QUITS /IGNORE mike NO_ACT -MSGS - /IGNORE -regexp -pattern + /IGNORE mike HIDDEN PUBLIC JOINS PARTS QUITS + /IGNORE -time 5days christmas PUBLICS + /IGNORE -time 300 mike PUBLICS %9See also:%9 ACCEPT, SILENCE, UNIGNORE diff --git a/docs/help/in/info.in b/docs/help/in/info.in index 275f349d..d8d8cfc9 100644 --- a/docs/help/in/info.in +++ b/docs/help/in/info.in @@ -15,7 +15,7 @@ %9Examples:%9 /INFO - /INFO orwell.freenode.net + /INFO irc.libera.chat %9See also:%9 ADMIN diff --git a/docs/help/in/ison.in b/docs/help/in/ison.in index c77e4c59..e9e54ee9 100644 --- a/docs/help/in/ison.in +++ b/docs/help/in/ison.in @@ -16,5 +16,5 @@ /ISON mike /ISON sarah bob -%9See also:%9 NOTIFY, WHOAS, WHOIS +%9See also:%9 NOTIFY, WHOWAS, WHOIS diff --git a/docs/help/in/join.in b/docs/help/in/join.in index 39fa23f8..adf7158e 100644 --- a/docs/help/in/join.in +++ b/docs/help/in/join.in @@ -20,7 +20,7 @@ /JOIN #irssi /JOIN #basementcat secret_lair /JOIN -invite - /JOIN -freenode #github,#freenode,#irssi + /JOIN -liberachat #github,#libera,#irssi %9See also:%9 KICK, PART diff --git a/docs/help/in/knock.in b/docs/help/in/knock.in index bb554d55..ce8f9aa0 100644 --- a/docs/help/in/knock.in +++ b/docs/help/in/knock.in @@ -23,7 +23,7 @@ %9Examples:%9 /KNOCK #irssi - /KNOCK #freenode + /KNOCK #libera /KNOCK #github %9See also:%9 INVITE, JOIN diff --git a/docs/help/in/levels.in b/docs/help/in/levels.in index 429dd7c0..3c61263d 100644 --- a/docs/help/in/levels.in +++ b/docs/help/in/levels.in @@ -20,9 +20,10 @@ MODES A channel mode is modified. MSGS Private messages. NICKS A nickname changes to another nickname. - NOTICES Notices sent from a nickname. + NOTICES Private notices. PARTS A nickname leaves a channel. PUBLIC Public messages in a channel. + PUBNOTICES Public notices in a channel. QUITS A nickname disconnects from IRC. SNOTES Notices sent from a server. TOPICS A channel topic is modified. @@ -32,8 +33,10 @@ HILIGHT The text is highlighted. NEVER Never ignores or logs the message. + HIDDEN Hides the message when window HIDELEVEL includes HIDDEN. NO_ACT Doesn't trigger any activity in the statusbar. NOHILIGHT The text is not highlighted. + Suppresses hilights when used with /ignore. When using levels from Irssi scripts, you need to prepend the level with 'MSGLEVEL_'; for example 'CRAP' becomes 'MSGLEVEL_CRAP'. diff --git a/docs/help/in/list.in b/docs/help/in/list.in index b796eed0..6dda79e6 100644 --- a/docs/help/in/list.in +++ b/docs/help/in/list.in @@ -24,11 +24,15 @@ %9Remarks:%9 - Not all networks support server-side filtering and may provide a network + Not all networks support server-side filtering. Some provide a network service or service bot instead; on IRCnet, you may use the List service: - /SQUERY List HELP - /MSG ALIS HELP + /SQUERY Alis HELP + + Other networks with service bots (like ChanServ) may also provide a list + service bot (confirm with /WHOIS ALIS): + + /MSG Alis HELP %9See also:%9 STATS, SQUERY, WHOIS diff --git a/docs/help/in/log.in b/docs/help/in/log.in index e4743d46..3ca8782c 100644 --- a/docs/help/in/log.in +++ b/docs/help/in/log.in @@ -33,10 +33,10 @@ %9Examples:%9 /LOG OPEN -targets mike ~/irclogs/mike.log MSGS - /LOG OPEN -targets #irssi-freenode ~/irclogs/freenode/irssi-%%Y-%%m-%%d - /LOG CLOSE ~/irclogs/freenode/irssi-%%Y-%%m-%%d - /LOG STOP ~/irclogs/freenode/irssi-%%Y-%%m-%%d - /LOG START ~/irclogs/freenode/irssi-%%Y-%%m-%%d + /LOG OPEN -targets #irssi ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG CLOSE ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG STOP ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG START ~/irclogs/liberachat/irssi-%%Y-%%m-%%d /SET autolog ON diff --git a/docs/help/in/lusers.in b/docs/help/in/lusers.in index f9edf535..99089fb7 100644 --- a/docs/help/in/lusers.in +++ b/docs/help/in/lusers.in @@ -5,7 +5,7 @@ %9Parameters:%9 - The server to search on and the remote sever to search on; if no arguments + The server to search on and the remote server to search on; if no arguments are given, the active server will be used. %9Description:%9 diff --git a/docs/help/in/meson.build b/docs/help/in/meson.build new file mode 100644 index 00000000..aa459b7d --- /dev/null +++ b/docs/help/in/meson.build @@ -0,0 +1 @@ +# don't forget to add new help files to ../meson.build diff --git a/docs/help/in/motd.in b/docs/help/in/motd.in index e33a1c75..6e86681e 100644 --- a/docs/help/in/motd.in +++ b/docs/help/in/motd.in @@ -15,7 +15,7 @@ %9Examples:%9 /MOTD - /MOTD orwel.freenode.org + /MOTD irc.libera.chat /MOTD bob %9See also:%9 ADMIN, INFO, LINKS, MAP diff --git a/docs/help/in/msg.in b/docs/help/in/msg.in index 9e0879e4..6c7dd70f 100644 --- a/docs/help/in/msg.in +++ b/docs/help/in/msg.in @@ -11,8 +11,13 @@ The target nickname or channel and the message to send. - Use the wildcard character '*' if you want to use the active nickname or - channel. + The target can be a comma delimited list of targets, ie + nick1,nick2 or #chan1,#chan2 + + Or one of the following special targets: + * : Use the active nickname or channel + , : Last person who sent you a /msg + . : Last person you sent a /msg to %9Description:%9 diff --git a/docs/help/in/names.in b/docs/help/in/names.in index 8fd8cf91..974b845f 100644 --- a/docs/help/in/names.in +++ b/docs/help/in/names.in @@ -21,7 +21,7 @@ %9Examples:%9 /NAMES -ops - /NAMES -voices #irssi,#freenode + /NAMES -voices #irssi,#libera %9See also:%9 JOIN, PART, WHO, WHOIS diff --git a/docs/help/in/nctcp.in b/docs/help/in/nctcp.in index 93c3f3ec..9f516730 100644 --- a/docs/help/in/nctcp.in +++ b/docs/help/in/nctcp.in @@ -15,7 +15,7 @@ %9Examples:%9 /NCTCP #irssi VERSION King of the Jungle v1.0 - /NCTCP bob,#freenode USERINFO I am bob :p + /NCTCP bob,#libera USERINFO I am bob :p %9See also:%9 CTCP diff --git a/docs/help/in/network.in b/docs/help/in/network.in index ba08ef69..16ff9f47 100644 --- a/docs/help/in/network.in +++ b/docs/help/in/network.in @@ -11,13 +11,15 @@ REMOVE: Removes a network from your configuration. -nick: Specifies the nickname to use. + -alternate_nick Specifies the alternate nickname to use. -user: Specifies the user identity to use. -realname: Specifies the real name to use. -host: Specifies the hostname to use. -usermode: Specifies the user modes to set on yourself. -autosendcmd: Specifies the commands, separated by the ';' character, and enclosed within two "'" characters, to perform after - connecting. + connecting. + (Some characters need to be escaped - see /help eval) -querychans: Specifies the maximum number of channels to put in one MODE or WHO command when synchronizing. -whois: Specifies the maximum number of nicknames in one WHOIS @@ -34,8 +36,9 @@ -cmdmax: Specifies the maximum number of commands to perform before starting the internal flood protection. -sasl_mechanism Specifies the mechanism to use for the SASL authentication. - At the moment irssi only supports the 'plain' and the - 'external' mechanisms. + Irssi supports: PLAIN, EXTERNAL, SCRAM-SHA-1, SCRAM-SHA-256 + and SCRAM-SHA-512 + Use '' to disable the authentication. -sasl_username Specifies the username to use during the SASL authentication. -sasl_password Specifies the password to use during the SASL authentication. @@ -57,11 +60,11 @@ %9Examples:%9 /NETWORK ADD -usermode +giw EFnet - /NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host staff.irssi.org Freenode - /NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' Freenode + /NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host staff.irssi.org liberachat + /NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' liberachat /NETWORK ADD -autosendcmd '^MSG Q@CServe.quakenet.org AUTH mike WzerT8zq; WAIT 2000; OPER mike WzerT8zq; WAIT 2000; MODE mike +kXP' Quakenet /NETWORK MODIFY -usermode +gi EFnet - /NETWORK REMOVE Freenode + /NETWORK REMOVE liberachat %9See also:%9 CHANNEL, CONNECT, SERVER diff --git a/docs/help/in/otr.in b/docs/help/in/otr.in new file mode 100644 index 00000000..fcfcd875 --- /dev/null +++ b/docs/help/in/otr.in @@ -0,0 +1,111 @@ + +OTR %|[OPTION] + +Command to control the OTR module. Without an option, /OTR INFO is printed. + +This help contains three sections which are %9options, quickstart and files.%n + +To add the OTR status bar (highly recommended): + +%9/statusbar window add otr%n + +%9Options:%n + +AUTH + Start or respond to an authentication process. + +AUTHQ + Start a SMP authentication process. + + Example: %9/otr authq "My question is" "this is the secret"%n + +AUTHABORT + Abort an ongoing authentication process. + +CONTEXTS + List known contexts which basically list the known fingerprints and their + state. + +DEBUG + Turn on debugging. + +DISTRUST + Distrust a specific fingerprint. This command can be done inside a private + window for which the current fingerprint of the other person will be used + or else set fp to a human readable OTR fingerprint available with the above + contexts command. + + Examples: %9/otr distrust 487FFADA 5073FEDD C5AB5C14 5BB6C1FF 6D40D48A%n + +FINISH + End the OTR session. This MUST be done inside a private conversation + window. + +FORGET + Forget a specific fingerprint (deleted from the known fingerprints). The + behavior is the same as the distrust command explained above. + +GENKEY + Generate OTR keys for a given account name. This is done automatically + if someone tries to establish a secure session. + + This process is done in a background worker and can take an arbitrary + amount of time. The completion is checked when another irssi event is + caught. + +HELP + Print this help. + +INFO + Display the OTR fingerprint(s) of all your account(s). + +INIT + Initialize an OTR conversation within a private conversation window. + +TRUST + Trust a specific fingerprint. The behavior is the same as the forget and + distrust commands explained above. + +VERSION + Print the version of the OTR module. + +%9Quickstart:%n + +Start a private conversation with the person you want to initiate a secure +session. Once in the private message window: + +%9/otr init%n + +Key generation should start if no key is found for your account name. Once the +process is done, either type a message which should automatically start the +session or redo the init command. + +Time to authenticate the person. Either use a shared secret exchange through +phone or GPG-signed email or use the socialist millionaire problem mechanism +(SMP) which is basically to ask a question for which the answer can only be +known by the other person. + +%9/otr auth %n OR %9/otr authq "A question" %n + +Or to respond to an authentication: + +%9/otr auth %n + +%9Files:%n + +This otr modules creates a directory in %9$HOME/.irssi/otr%n and creates three +files: + +* %9otr.key%n + Contains your OTR private key(s). NEVER shared this directory with someone + else unless you know what you are doing. + +* %9otr.fp%n + The known fingerprints with their _trust_ status. + +* %9otr.instag + Instance tag of the libotr. This should NEVER be copied to an other + computer. If unsure, just ignore this file. + +For more information on OTR, see https://otr.cypherpunks.ca/ + diff --git a/docs/help/in/part.in b/docs/help/in/part.in index e96abfbb..f89769cc 100644 --- a/docs/help/in/part.in +++ b/docs/help/in/part.in @@ -14,7 +14,7 @@ %9Examples:%9 /PART #irssi - /PART #freenode,#irssi + /PART #libera,#irssi %9See also:%9 JOIN, KICK diff --git a/docs/help/in/query.in b/docs/help/in/query.in index 1c0ba5b9..a34f85e8 100644 --- a/docs/help/in/query.in +++ b/docs/help/in/query.in @@ -17,8 +17,8 @@ %9Examples:%9 /QUERY mike - /QUERY -freenode bob - /QUERY -freenode -window sarah + /QUERY -liberachat bob + /QUERY -liberachat -window sarah %9See also:%9 MSG, UNQUERY, WINDOW diff --git a/docs/help/in/recode.in b/docs/help/in/recode.in index 63f52339..760c66cd 100644 --- a/docs/help/in/recode.in +++ b/docs/help/in/recode.in @@ -22,7 +22,7 @@ %9Examples:%9 /RECODE - /RECODE ADD Freenode/mike utf-8 + /RECODE ADD liberachat/mike utf-8 /RECODE ADD #korea euc-kr /RECODE REMOVE #korea diff --git a/docs/help/in/reconnect.in b/docs/help/in/reconnect.in index aa1dc946..87beb95a 100644 --- a/docs/help/in/reconnect.in +++ b/docs/help/in/reconnect.in @@ -15,7 +15,7 @@ %9Examples:%9 /RECONNECT - /RECONNECT Freenode + /RECONNECT liberachat /RECONNECT EFnet BRB :) %9See also:%9 CONNECT, DISCONNECT, NETWORK, RMRECONNS, SERVER diff --git a/docs/help/in/scrollback.in b/docs/help/in/scrollback.in index 5f59d842..e91513cd 100644 --- a/docs/help/in/scrollback.in +++ b/docs/help/in/scrollback.in @@ -20,10 +20,10 @@ %9Description:%9 - Manipulate the text in the window to go to a to the given line number, or + Manipulate the text in the window to go to the given line number, or clear the buffers. - The timestamp format is format is '[dd[.mm] | -] hh:mi[:ss]'. + The timestamp format is '[dd[.mm] | -] hh:mi[:ss]'. %9Examples:%9 diff --git a/docs/help/in/server.in b/docs/help/in/server.in index 60870111..84b5ad78 100644 --- a/docs/help/in/server.in +++ b/docs/help/in/server.in @@ -5,7 +5,7 @@ %9Parameters:%9 - LIST: Displays the list of servers you are connected to. + LIST: Displays the list of servers you have configured. CONNECT: Connects to the given server. ADD: Adds a server to your configuration. MODIFY: Modifies a server in your configuration. @@ -16,11 +16,13 @@ -4: Connects using IPv4. -6: Connects using IPv6. -tls: Connects using TLS encryption. + -notls: Connect without TLS encrption. -tls_cert: The TLS client certificate file. -tls_pkey: The TLS client private key, if not included in the certificate file. -tls_pass: The password for the TLS client private key or certificate. - -tls_verify: Verifies the TLS certificate of the server. + -tls_verify: Verifies the TLS certificate of the server. + -notls_verify: Doesn't verify the TLS certificate of the server. -tls_cafile: The file with the list of CA certificates. -tls_capath: The directory which contains the CA certificates. -tls_ciphers: TLS cipher suite preference lists. @@ -28,6 +30,8 @@ -tls_pinned_pubkey: Pinned public key fingerprint. -auto: Automatically connects to the server on startup. -noauto: Doesn't connect to the server on startup. + -cap: Enable CAPREQ for server. + -nocap: Disable CAPREQ for server. -network: The network the server belongs to. -host: The hostname you would like to connect from. -cmdspeed: Specifies the minimum amount of time, expressed in @@ -51,24 +55,24 @@ When using the ADD parameter on a server that already exists, the configuration will be merged with each other. - When using the command without any of the given parameters, it will - connect to the specified server; the server in the active window will be - disconnected unless you prepend the server with the '+' character; the same - method is applicable to the CONNECT parameter. + When using the CONNECT parameter, it will connect to the specified + server; the server in the active window will be disconnected + unless you prepend the server with the '+' character. + + Specify '-' as password to remove a server password %9Examples:%9 /SERVER - /SERVER chat.freenode.net - /SERVER +chat.freenode.net - /SERVER CONNECT chat.freenode.net - /SERVER CONNECT +chat.freenode.net - /SERVER ADD -network Freenode -noautosendcmd orwell.freenode.net - /SERVER ADD -! -auto -host staff.irssi.org -port 6667 -4 -network Freenode -noproxy orwell.freenode.net - /SERVER MODIFY -network Freenode -noauto orwell.freenode.net - /SERVER REMOVE orwell.freenode.net 6667 Freenode + /SERVER CONNECT irc.libera.chat + /SERVER CONNECT +irc.libera.chat + /SERVER ADD -network liberachat -noautosendcmd irc.libera.chat + /SERVER ADD -! -auto -host staff.irssi.org -4 -network liberachat -noproxy irc.libera.chat 6667 + /SERVER MODIFY -network liberachat -noauto irc.libera.chat + /SERVER MODIFY -network liberachat irc.libera.chat 6697 - + /SERVER REMOVE irc.libera.chat 6667 liberachat /SERVER PURGE - /SERVER PURGE orwell.freenode.net + /SERVER PURGE irc.libera.chat %9See also:%9 CHANNEL, CONNECT, DISCONNECT, NETWORK, RECONNECT, RMRECONNS diff --git a/docs/help/in/set.in b/docs/help/in/set.in index b2a4551b..097ace7e 100644 --- a/docs/help/in/set.in +++ b/docs/help/in/set.in @@ -7,6 +7,7 @@ -clear: Removes the setting's value from the configuration. -default: Restore the setting to its default value. + -section: Print settings under the specified section The setting and the value; if no value is given, the list of settings that matched will be returned. If no arguments are given, all the settings will @@ -27,6 +28,7 @@ /SET -clear nick /SET log_timestamp %%H:%%H:%%S /SET -default log_timestamp + /SET -section lookandfeel /SET close %9See also:%9 SAVE, TOGGLE diff --git a/docs/help/in/statusbar.in b/docs/help/in/statusbar.in index ac475dd5..ac57ca5f 100644 --- a/docs/help/in/statusbar.in +++ b/docs/help/in/statusbar.in @@ -5,32 +5,61 @@ %9Parameters:%9 - ENABLE: Enables the statusbar. - DISABLE: Disabled the statusbar. + ADD: Adds a statusbar to the list of statusbars. + MODIFY: Modifies the configuration of a statusbar. RESET: Restores the default statusbar configuration. - TYPE: Identifies the type of statusbar. - PLACEMENT: Identifies the placement of the statusbar. - POSITION: Identifies the position of the statusbar. - VISIBLE: Identifies the visibility of the statusbar. - ADD: Adds a statusbar into the configuration. - REMOVE: Removes a statusbar from the configuration. + ADDITEM: Adds an item to the specified statusbar. It can be set to + appear before/after another item and left/right aligned + on the screen. + MODIFYITEM: Changes an item position inside a bar. + REMOVEITEM: Removes an item from the specified statusbar. + INFO: List the current details and items of the specified + statusbar. - The name of the statusbar; if no argument is given, the list of statusbars - will be displayed. + -disable: Removes a statusbar from the list. + -type: Sets the type of statusbar, for each split window or only + once at the root (very top or bottom) of the screen. + -placement: Sets the placement of the statusbar, either at the top or + the bottom of the screen or split window. + -position: Sets the position of the statusbar. Represented as a + number, with smaller numbers implying a position further + to the top. + -visible: Sets the visibility of the statusbar. If set to always, + it is visible on all split windows, otherwise if set to + inactive or active then it is only visible on inactive or + active split windows, respectively. + -before: This item is added before the other item. + -after: This item is added after the other item. + -priority: When the statusbar items overflow, the item with the + lowest priority is removed or truncated first. + Priority can be negative, in which case it'll have to be + quoted (e.g. -priority "-1") + -alignment: Display the item on the right side. + + Where statusbar refers to the name of the statusbar; if no + argument is given, or `LIST` is given, the entire list of + statusbars along with a quick overview of their properties will be + displayed. %9Description:%9 - Modified the attributes of the statusbar. + Allows adjustment of the attributes and items of a statusbar, as well + as where it is located and whether or not it is currently visible. %9Examples:%9 /STATUSBAR - /STATUSBAR window - /STATUSBAR window REMOVE time - /STATUSBAR window ADD time - /STATUSBAR window RESET - /STATUSBAR topic DISABLE - /STATUSBAR topic ENABLE + /STATUSBAR INFO window + /STATUSBAR REMOVEITEM time window + /STATUSBAR ADDITEM time window + /STATUSBAR RESET window + /STATUSBAR MODIFY -disable topic + /STATUSBAR MODIFY -nodisable topic + +%9Remarks:%9 + + Statusbar syntax was changed in Irssi 1.2. The old syntax is still + accepted for backward compatibility, but no longer documented. %9See also:%9 WINDOW diff --git a/docs/help/in/toggle.in b/docs/help/in/toggle.in index f87a6462..9469ba5c 100644 --- a/docs/help/in/toggle.in +++ b/docs/help/in/toggle.in @@ -15,7 +15,6 @@ %9Examples:%9 - /TOGGLE resolve_prefer_ipv6 /TOGGLE channels_rejoin_unavailable ON %9See also:%9 SET diff --git a/docs/help/in/window.in b/docs/help/in/window.in index 6dde6c50..5a8ecbd0 100644 --- a/docs/help/in/window.in +++ b/docs/help/in/window.in @@ -33,22 +33,28 @@ THEME: %|Applies or removes a per-window theme. GROW: %|Increase the size of the active split window by the specified number of lines. SHRINK: %|Decrease the size of the active split window by the specified number of lines. - SIZE: %|Set the current split window size to the specified numer of lines. + SIZE: %|Set the current split window size to the specified number of lines. BALANCE: %|Balance the heights of all split windows. HIDE: %|Hides the current split window, or the split window specified by number or item name. SHOW: %|Show the window specified by number or item name as a new split windows. It is made sticky when autostick_split_windows is turned on. - UP: %|Set the split window above the current one active. At the top, wraps to the bottom. - DOWN: %|Set the split window below the current one active. At the bottom, wraps to the top. + UP: %|Set the split window left or above the current one active. At the top, wraps to the bottom. + DOWN: %|Set the split window right or below the current one active. At the bottom, wraps left. LEFT: %|Go to the previous window numerically that is part of the current sticky group (or not part of any sticky group). RIGHT: %|Go to the next window numerically that is part of the current sticky group (or not part of any sticky group). STICK: %|Make the currently active window sticky, or stick the window specified by number to the currently visible split window. Or turn off stickyness of the currently active window or the window specified by number. + HIDELEVEL: %|Changes the levels of text lines that should be hidden from view, or query the current hidden level. MOVE LEFT: %|Move the window to the numerically previous location inside the current sticky group. MOVE RIGHT: %|Move the window to the numerically next location inside the current sticky group. - MOVE UP: %|Move the current window to the sticky group of the split window above. If no sticky group remains, the split window collapses. - MOVE DOWN: %|Move the current window to the sticky group of the split window below. If no sticky group remains, the split window collapses. + MOVE UP: %|Move the current window to the sticky group of the previous split window. If no sticky group remains, the split window collapses. + MOVE DOWN: %|Move the current window to the sticky group of the next split window. If no sticky group remains, the split window collapses. + + -right: %|Makes the command work on the width instead of height, or create the split window to the right instead of top. + -directional: %|Set the split window in the given direction to the current one active, or move the current window to the sticky group of the split window in the given direction. (If no sticky group remains, the split window collapses.) %|Add the required arguments for the given command. Without arguments, the details (size, immortality, levels, server, name and sticky group) of the currently active window are displayed. If used with a number as argument, same as WINDOW REFNUM. + %|LEVEL and HIDELEVEL modify the currently set level. Without arguments, the current level is displayed. Levels listed starting with `+' are added to the current levels. Levels listed starting with `-' are removed from the current levels. To clear the levels, start the new level setting with `NONE'. Levels listed starting with `^' are either removed or added from the current setting, depending on whether they were previously set or not (since Irssi 1.4.4). Levels listed as is are also added to the current levels. Afterwards, the new level setting is displayed. + %9Description:%9 Manipulates the window layout and positioning attributes. @@ -65,7 +71,8 @@ /WINDOW LOG OFF /WINDOW LOG ON ~/logs/debug.log /WINDOW LEVEL -ALL +NOTICES + /WINDOW HIDELEVEL ^JOINS ^PARTS ^QUITS /WINDOW LOGFILE ~/logs/notices.log -%9See also:%9 JOIN, LEVELS, LOG, QUERY +%9See also:%9 JOIN, LEVELS, LOG, QUERY, SET window_default_level, SET window_default_hidelevel diff --git a/docs/help/meson.build b/docs/help/meson.build new file mode 100644 index 00000000..6eaa3025 --- /dev/null +++ b/docs/help/meson.build @@ -0,0 +1,122 @@ +install_data( + files( + 'accept', + 'action', + 'admin', + 'alias', + 'away', + 'ban', + 'beep', + 'bind', + 'cat', + 'cd', + 'channel', + 'clear', + 'completion', + 'connect', + 'ctcp', + 'cycle', + 'dcc', + 'dehilight', + 'deop', + 'devoice', + 'die', + 'disconnect', + 'echo', + 'eval', + 'exec', + 'flushbuffer', + 'format', + 'hash', + 'help', + 'hilight', + 'ignore', + 'info', + 'invite', + 'irssiproxy', + 'ison', + 'join', + 'kick', + 'kickban', + 'kill', + 'knock', + 'knockout', + 'lastlog', + 'layout', + 'levels', + 'links', + 'list', + 'load', + 'log', + 'lusers', + 'map', + 'me', + 'mircdcc', + 'mode', + 'motd', + 'msg', + 'names', + 'nctcp', + 'netsplit', + 'network', + 'nick', + 'notice', + 'notify', + 'op', + 'oper', + 'otr', + 'part', + 'ping', + 'query', + 'quit', + 'quote', + 'rawlog', + 'recode', + 'reconnect', + 'rehash', + 'reload', + 'restart', + 'rmreconns', + 'rmrejoins', + 'save', + 'sconnect', + 'script', + 'scrollback', + 'server', + 'servlist', + 'set', + 'silence', + 'squery', + 'squit', + 'stats', + 'statusbar', + 'time', + 'toggle', + 'topic', + 'trace', + 'ts', + 'unalias', + 'unban', + 'unignore', + 'unload', + 'unnotify', + 'unquery', + 'unsilence', + 'upgrade', + 'uptime', + 'userhost', + 'ver', + 'version', + 'voice', + 'wait', + 'wall', + 'wallops', + 'who', + 'whois', + 'whowas', + 'window', + ), + install_dir : helpdir, +) + +# subdir('in') diff --git a/docs/irssi.1 b/docs/irssi.1 index e1fab0d8..08be69f5 100644 --- a/docs/irssi.1 +++ b/docs/irssi.1 @@ -59,7 +59,7 @@ show a help message .SH SEE ALSO .B Irssi has a solid amount of documentation available; check /HELP or look online -at http://www.irssi.org +at https://irssi.org .SH FILES .TP .I ~/.irssi/config diff --git a/docs/manual.txt b/docs/manual.txt index b2d0de14..073abe18 100644 --- a/docs/manual.txt +++ b/docs/manual.txt @@ -1,5 +1,5 @@ - Irssi 0.8 documentation - http://www.irssi.org/ + Irssi 0.8 documentation - https://irssi.org/ Copyright(c) 2000 Timo Sirainen @@ -18,16 +18,16 @@ 9. Text highlighting 10. Ignoring 11. Logging + 12. Commands + 14. Last log (currently text version only) + 15. Word completion + 16. Recode + 18. Key bindings (text version) + 19. Perl scripting ( not written yet: ) - 12. Commands 13. Themes - 14. Last log (currently text version only) - 15. Nick and word completion - 16. Recode 17. Windowing system (text version) - 18. Keyboard (text version) - 19. Perl scripting @@ -141,44 +141,7 @@ --hostname -h Specify what host name to use - 2. Message levels - - - Message levels (or in short, levels) are used almost everywhere. - They describe what kind of messages we're dealing with. Here's a - list of them all: - - CRAP - Can be almost anything - MSGS - Private messages - PUBLIC - Public messages in channel - NOTICES - Notices - SNOTES - Server notices - CTCPS - CTCP messages - ACTIONS - Actions (/me) - usually ORed with PUBLIC or MSGS - JOINS - Someone joins a channel - PARTS - Someone parts a channel - QUITS - Someone quits IRC - KICKS - Someone gets kicked from channel - MODES - Channel mode is changed - TOPICS - Channel topic is changed - WALLOPS - Wallop is received - INVITES - Invite is received - NICKS - Someone changes nick - DCC - DCC related messages - DCCMSGS - DCC chat messages - CLIENTNOTICES - Irssi's notices - CLIENTERRORS - Irssi's error messages - CLIENTCRAP - Some other messages from Irssi - - And a few special ones that could be included with the - levels above: - - HILIGHT - Text is highlighted - NOHILIGHT - Don't check highlighting for this message - NO_ACT - Don't trigger channel activity when printing - this message - NEVER - Never ignore or log this message - + 2. Message levels 3. Flood protection @@ -252,47 +215,12 @@ Currently only messages, notices and ctcps are checked for flooding. - /SET flood_max_msgs = , default is 4 - /SET flood_timecheck = , default is 5 seconds + /SET flood_max_msgs , default is 4 + /SET flood_timecheck , default is 5 seconds If either of these is 0, the flood checking is disabled. - 4. Configuration - - 4.1 Configuration files - - The configuration is saved to ~/.irssi/config file. You can edit - it with text editor if you want, you can also add comments to it - and they stay there even if /SAVE is used. Comments are the lines - starting with # character. Any errors in config file are displayed - at startup. - - Irssi uses it's own config library for handling the config file. - The format is pretty much the same as in libPropList and should be - easily understandable. - - You can reload the config file on the fly with /RELOAD command, you - can also read a different config file with /RELOAD . - - If you change any settings, they aren't saved to file until you use - /SAVE. You can save the config file to different place with - /SAVE . - - 4.2 Settings - - You can view or change the settings with /SET command. - - /SET without any arguments displays all the settings. - /SET displays settings which key (partly) matches - /SET sets to - - Boolean settings accepts only values ON, OFF and TOGGLE. You can - also use /TOGGLE command to change them, so /TOGGLE behaves - like /SET TOGGLE. /TOGGLE also accepts arguments ON and OFF - when /TOGGLE behaves exactly like /SET. - - Remember that changes are not saved until you use /SAVE! - + 4. Configuration 5. Servers @@ -349,7 +277,7 @@ after connecting to the network. This is useful for automatically identifying yourself to NickServ, for example - /NETWORK ADD -autosendcmd "/^msg NickServ identify secret" freenode + /NETWORK ADD -autosendcmd "/^msg NickServ identify secret" liberachat /NETWORK REMOVE @@ -367,11 +295,11 @@ you setup the server using /SERVER ADD (see next section). If the settings can't be found there either, Irssi will use the defaults: - /SET default_nick = , defaults to user_name - /SET alternate_nick = , defaults to _ - /SET user_name = , defaults to your login name - /SET real_name = , taken from /etc/passwd by default - /SET hostname = , what host name to use when connecting + /SET default_nick , defaults to user_name + /SET alternate_nick , defaults to _ + /SET user_name , defaults to your login name + /SET real_name , taken from /etc/passwd by default + /SET hostname , what host name to use when connecting /SET skip_motd ON|OFF|TOGGLE - Don't show server's MOTD NOTE: /CONNECT is also a command for IRC operators to connect IRC @@ -394,10 +322,26 @@ 5.4 Server settings - /SERVER ADD [-auto | -noauto] [-network ] [-host ] + /SERVER ADD [-tls] [-tls_cert ] [-tls_pkey ] + [-tls_pass ] [-tls_verify] [-tls_cafile ] + [-tls_capath ] [-tls_ciphers ] + [-tls_pinned_cert ] [-tls_pinned_pubkey ] + [-auto | -noauto] [-network ] [-host ] [-cmdspeed ] [-cmdmax ] [-port ]
[ []] + -tls: Connects using TLS encryption. + -tls_cert: The TLS client certificate file. + -tls_pkey: The TLS client private key, if not included in the + certificate file. + -tls_pass: The password for the TLS client private key or + certificate. + -tls_verify: Verifies the TLS certificate of the server. + -tls_cafile: The file with the list of CA certificates. + -tls_capath: The directory which contains the CA certificates. + -tls_ciphers: TLS cipher suite preference lists. + -tls_pinned_cert: Pinned x509 certificate fingerprint. + -tls_pinned_pubkey: Pinned public key fingerprint. -auto: Automatically connect to server at startup -noauto: Don't connect to server at startup (default) -network: Specify what IRC network this server belongs to @@ -429,9 +373,6 @@ After connected to server, Irssi can automatically change your user mode. You can set it with /SET usermode , default is +i. - /SET resolve_prefer_ipv6 - If ON, prefer IPv6 for hosts that - have both v4 and v6 addresses. - 5.5 Automatic reconnecting If you get disconnected from server, Irssi will try to reconnect @@ -776,13 +717,7 @@ /SET massjoin_max_joins . - 7. IRC commands and features (FIXME) - - 7.x Basic commands - - 7.x IRC operator commands - - 7.x Away features + 7. IRC commands and features 8. Notify list @@ -830,9 +765,9 @@ /HILIGHT without any arguments displays list of the hilights. -If is a - number, Irssi will treat it as a MIRC color code. You can also use - bolds (^B), underlines (^_) etc. as if you like. + If is a number, Irssi will treat it as a MIRC color + code. You can also use bolds (^B), underlines (^_) etc. as + if you like. 10. Ignoring @@ -977,29 +912,24 @@ If is a You can disable this feature by setting awaylog_level to NONE. - 12. Commands + 12. Commands - Any char in the `cmdchars' setting can begin a command. The - syntax for a command is the following: + 13. Themes - [][^] + 14. Last log - If is repeated two times, alias expansion is - disabled, enabled otherwise. If `^' is present, command output - is disabled. If begins with a space, command lookup is - inhibited and the data is sent to the active window item - (useful to send a line that begins with ). + 15. Word completion 16. Recode - irssi supports selective encoding of incoming/outgoing messages + Irssi supports selective encoding of incoming/outgoing messages through the recode system. All incoming/outgoing messages can be optionally converted to/from the charset specified by the `term_charset' variable (which defaults to the locale encoding and should _not_ be changed in most cases), by setting the `recode' variable to 'ON'. Since there is no way in IRC to know the encoding associated to a - message, for incoming messages irssi uses the following algorithm: + message, for incoming messages Irssi uses the following algorithm: if `recode_autodetect_utf8' is 'ON' and the message is valid UTF-8 the encoding is assumed to be UTF-8. @@ -1016,5 +946,9 @@ If is a iconv specific extension to peform transliteration (locale dependent) when a character is not representable in the destination encoding. + 18. Key bindings + + 19. Scripting + .. no, the docs end here, I got bored of writing these after a few days and haven't touched these since then. diff --git a/docs/meson-macos-ar.txt b/docs/meson-macos-ar.txt new file mode 100644 index 00000000..77e5cb8e --- /dev/null +++ b/docs/meson-macos-ar.txt @@ -0,0 +1,6 @@ +;; manual workaround for meson bug https://github.com/mesonbuild/meson/issues/11165 +;; fixes compilation with meson on apple macos +;; usage: meson --native-file ./docs/meson-macos-ar.txt ... + +[binaries] +ar = ['/bin/sh', '-c', 'ar=${AR:-ar}; ranlib=${RANLIB:-ranlib -c -}; case "x$1" in xcsr*) $ar "$@" && $ranlib "$2" || exit $?; ;; *) exec $ar "$@"; ;; esac;', 'ar'] diff --git a/docs/meson.build b/docs/meson.build new file mode 100644 index 00000000..f6761200 --- /dev/null +++ b/docs/meson.build @@ -0,0 +1,19 @@ +install_data( + files( + 'capsicum.txt', + 'design.html', + 'design.txt', + 'faq.html', + 'faq.txt', + 'formats.txt', + 'manual.txt', + 'perl.txt', + 'signals.txt', + 'special_vars.txt', + 'startup-HOWTO.html', + 'startup-HOWTO.txt', + ), + install_dir : docdir, +) + +subdir('help') diff --git a/docs/perl.txt b/docs/perl.txt index 59f65462..b8e097c7 100644 --- a/docs/perl.txt +++ b/docs/perl.txt @@ -178,6 +178,9 @@ listed after the generic ones. Window active_win() - return active window Server active_server() - return server in active window +get_irssi_dir() - returns the absolute path to the user configuration + directory - either the value passed to --home at startup, or ~/.irssi + windows() - return list of all windows servers() - return list of all servers reconnects() - return list of all server reconnections @@ -202,6 +205,12 @@ Window::command(cmd) Windowitem::command(cmd) Send a command `cmd' (in current channel). The '/' char isn't needed. +version() - return client release date and time (format YYYYMMDD.hhmm) + +parse_special(cmd, data="", flags=0) +Server::parse_special(cmd, data="", flags=0) +Windowitem::parse_special(cmd, data="", flags=0) + evaluate a string with special vars *** Themes @@ -513,6 +522,8 @@ Connect->{} address - Address where we connected (irc.blah.org) port - Port where we connected chatnet - Chat network + chosen_family - IP family chosen to connect to + ipaddr - IP address connected to password - Password we used in connection. wanted_nick - Nick which we would prefer to use @@ -1192,6 +1203,7 @@ Client->{} Bugs and Limitations -------------------- * Calling die in 'script error' handler causes segfault (#101) +* Calling "script unload" from your own script causes segfault * Storing and later using any Irssi object may result in use-after-free related crash - Workaround: always acquire fresh objects * Calling $dcc->close from the "dcc created" signal will cause unstable behaviour and crashes (#386) diff --git a/docs/proxy.txt b/docs/proxy.txt index 224d24e3..172770e8 100644 --- a/docs/proxy.txt +++ b/docs/proxy.txt @@ -24,7 +24,7 @@ You really should set some password for the proxy with: Then you'll need to configure the ports/ircnets the proxy listens in, something like: - /SET irssiproxy_ports ircnet=2777 efnet=2778 freenode=2779 + /SET irssiproxy_ports IRCnet=2777 EFNet=2778 liberachat=2779 There we have 3 different irc networks answering in 3 ports. Note that you'll have to make the correct /IRCNET ADD and /SERVER ADD commands to diff --git a/docs/qna.html b/docs/qna.html new file mode 100644 index 00000000..a61ee40d --- /dev/null +++ b/docs/qna.html @@ -0,0 +1,52 @@ + + +

Right-aligned nicks

+

To create a “tabular” effect of the chat view, or to align nick names in a column, you can use Irssi’s theme/format system. The basic commands are the following:

+
/format own_msg {ownmsgnick $2 {ownnick $[-9]0}}$1
+/format own_msg_channel {ownmsgnick $3 {ownnick $[-9]0}{msgchannel $1}}$2
+/format pubmsg_me {pubmsgmenick $2 {menick $[-9]0}}$1
+/format pubmsg_me_channel {pubmsgmenick $3 {menick $[-9]0}{msgchannel $1}}$2
+/format pubmsg_hilight {pubmsghinick $0 $3 $[-9]1}$2
+/format pubmsg_hilight_channel {pubmsghinick $0 $4 $[-9]1{msgchannel $2}}$3
+/format pubmsg {pubmsgnick $2 {pubnick $[-9]0}}$1
+/format pubmsg_channel {pubmsgnick $3 {pubnick $[-9]0}{msgchannel $1}}$2
+
+
+

These are copied from the default theme’s default values, which are responsible for displaying your own messages sent to a channel (own_msg) as well as received messages (pubmsg) and the two basic highlightings (me and hilight).

+

Then, in front of the argument that contains the nick name ($0 in most cases, but $1 in pubmsg_hilight), an alignment modifier (see Appendix B: Special Variables and Expandos) has been added: [-9]. This means that the nicks will be right-aligned and truncated to 9 characters.

+

Note: Modifiers only work in the /format section of a theme (this may change in the future)

+

There are also some scripts that try to do the alignment for you, like: nm, nm2.

+

There are also some nice themes that extend the alignment to further formats, like: weed.

+

Automatic log-in to NickServ

+

Please check here => Automatic log-in to NickServ

+

CertFP Log-in

+

CertFP, short for Certificate Finger Print, is another method to log you in to NickServ. Instead of a password, it uses a Client Certificate.

+

In order to use it, you

+
    +

  • first need a certificate,

    • +

  • then configure Irssi to use this certificate,

    • +

  • and finally register the certificate with NickServ.

    • +
+

Irssi does not have built-in certificate management commands, so you need to use an external tool like openssl to create the certificate.

+

A step-by-step guide for the Libera Chat network can be found here => https://github.com/shabble/irssi-docs/wiki/liberachat_certfp

+

It is necessary that the certificate be available as a file; PKCS#11 is not supported.

+

Tor (The Onion Router)

+

Tor is an overlay network for anonymous communication. It operates a local SOCKS proxy for applications to use.

+

Unfortunately, Irssi currently does not support SOCKS proxies natively. As a workaround, you can install the ProxyChains-NG program (note, it must be the NG version).

+

Afterwards, you can launch Irssi like this:

+
proxychains4 irssi
+
+
+

Now your connections will go through the Proxy configured in ProxyChains-NG (Tor by default).

+

IRC networks may have different requirements to be able to connect via Tor. For the Libera Chat network, you will first need to set up CertFP Log-in using a clearnet connection, and then connect to their Onion Service palladium.libera.chat. More detailed instructions can be found here => https://github.com/shabble/irssi-docs/wiki/liberator

+

The following signatures were invalid: EXPKEYSIG

+

If you see such a message

+
Err:4 home:/ailin_nemui:/irssi-an  InRelease
+  The following signatures were invalid: EXPKEYSIG EDB7AED941EEDB57 home:ailin_nemui OBS Project <home:ailin_nemui@build.opensuse.org>
+
+
+

this means that the automatic signing key used by the Open Build Service expired. OBS renews the key periodically, but Debian does not support this.

+
+

Fix

+

Download the key again, following the regular OBS instructions. If it still does not work, verify if there is a second expired copy of the key in /etc/apt/trusted.gpg.d or in apt-key list and remove it as well.

+
\ No newline at end of file diff --git a/docs/qna.txt b/docs/qna.txt new file mode 100644 index 00000000..92f4f64c --- /dev/null +++ b/docs/qna.txt @@ -0,0 +1,111 @@ +# Right-aligned nicks # + +To create a “tabular” effect of the chat view, or to align nick names in a +column, you can use Irssi’s theme/format system. The basic commands are the +following: + +/format own_msg {ownmsgnick $2 {ownnick $[-9]0}}$1 +/format own_msg_channel {ownmsgnick $3 {ownnick $[-9]0}{msgchannel $1}}$2 +/format pubmsg_me {pubmsgmenick $2 {menick $[-9]0}}$1 +/format pubmsg_me_channel {pubmsgmenick $3 {menick $[-9]0}{msgchannel $1}}$2 +/format pubmsg_hilight {pubmsghinick $0 $3 $[-9]1}$2 +/format pubmsg_hilight_channel {pubmsghinick $0 $4 $[-9]1{msgchannel $2}}$3 +/format pubmsg {pubmsgnick $2 {pubnick $[-9]0}}$1 +/format pubmsg_channel {pubmsgnick $3 {pubnick $[-9]0}{msgchannel $1}}$2 + +These are copied from the default theme’s default values, which are responsible +for displaying your own messages sent to a channel (own_msg) as well as +received messages (pubmsg) and the two basic highlightings (me and hilight). + +Then, in front of the argument that contains the nick name ($0 in most cases, +but $1 in pubmsg_hilight), an alignment modifier (see [1]Appendix B: Special +Variables and Expandos) has been added: [-9]. This means that the nicks will be +right-aligned and truncated to 9 characters. + +Note: Modifiers only work in the /format section of a theme (this may change in +the future) + +There are also some scripts that try to do the alignment for you, like: nm, +nm2. + +There are also some nice themes that extend the alignment to further formats, +like: [2]weed. + +# Automatic log-in to NickServ # + +Please check here => [3]Automatic log-in to NickServ + +# CertFP Log-in # + +CertFP, short for Certificate Finger Print, is another method to log you in to +NickServ. Instead of a password, it uses a [4]Client Certificate. + +In order to use it, you + + • first need a certificate, + + • then configure Irssi to use this certificate, + + • and finally register the certificate with NickServ. + +Irssi does not have built-in certificate management commands, so you need to +use an external tool like openssl to create the certificate. + +A step-by-step guide for the Libera Chat network can be found here => [5]https: +//github.com/shabble/irssi-docs/wiki/liberachat_certfp + +It is necessary that the certificate be available as a file; PKCS#11 is not +supported. + +# Tor (The Onion Router) # + +[6]Tor is an overlay network for anonymous communication. It operates a local +[7]SOCKS proxy for applications to use. + +Unfortunately, Irssi currently does not support SOCKS proxies natively. As a +workaround, you can install the [8]ProxyChains-NG program (note, it must be the +NG version). + +Afterwards, you can launch Irssi like this: + +proxychains4 irssi + +Now your connections will go through the Proxy configured in ProxyChains-NG +(Tor by default). + +IRC networks may have different requirements to be able to connect via Tor. For +the Libera Chat network, you will first need to set up [9]CertFP Log-in using a +clearnet connection, and then connect to their [10]Onion Service +palladium.libera.chat. More detailed instructions can be found here => [11] +https://github.com/shabble/irssi-docs/wiki/liberator + +# The following signatures were invalid: EXPKEYSIG # + +If you see such a message + +Err:4 home:/ailin_nemui:/irssi-an InRelease + The following signatures were invalid: EXPKEYSIG EDB7AED941EEDB57 home:ailin_nemui OBS Project + +this means that the automatic signing key used by the Open Build Service +expired. OBS renews the key periodically, but Debian does not support this. + +## Fix ## + +Download the key again, following the regular OBS instructions. If it still +does not work, verify if there is a second expired copy of the key in /etc/apt/ +trusted.gpg.d or in apt-key list and remove it as well. + + +References: + +[1] https://irssi.org/documentation/settings/#a-b +[2] https://github.com/ronilaukkarinen/weed +[3] https://irssi.org/documentation/manual/automation/#automatic-log-in-to-nickserv +[4] https://en.wikipedia.org/wiki/Client_certificate +[5] https://github.com/shabble/irssi-docs/wiki/liberachat_certfp +[6] https://www.torproject.org/ +[7] https://en.wikipedia.org/wiki/SOCKS +[8] https://github.com/rofl0r/proxychains-ng +[9] https://irssi.org/documentation/qna/certfp/ +[10] https://libera.chat/guides/connect#accessing-liberachat-via-tor +[11] https://github.com/shabble/irssi-docs/wiki/liberator diff --git a/docs/signals.txt b/docs/signals.txt index 7776dad7..81a1e3fa 100644 --- a/docs/signals.txt +++ b/docs/signals.txt @@ -63,6 +63,7 @@ nicklist.c: "nicklist remove", CHANNEL_REC, NICK_REC "nicklist changed", CHANNEL_REC, NICK_REC, char *old_nick "nicklist host changed", CHANNEL_REC, NICK_REC + "nicklist account changed", CHANNEL_REC, NICK_REC, char *account "nicklist gone changed", CHANNEL_REC, NICK_REC "nicklist serverop changed", CHANNEL_REC, NICK_REC @@ -132,7 +133,10 @@ irc-servers.c: irc-cap.c "server cap ack ", SERVER_REC "server cap nak ", SERVER_REC + "server cap new ", SERVER_REC + "server cap delete ", SERVER_REC "server cap end", SERVER_REC + "server cap req", SERVER_REC, char *caps sasl.c "server sasl failure", SERVER_REC, char *reason @@ -141,11 +145,13 @@ sasl.c irc.c: "server event", SERVER_REC, char *data, char *sender_nick, char *sender_address + "server event tags", SERVER_REC, char *data, char *sender_nick, char *sender_address, char *tags "event ", SERVER_REC, char *args, char *sender_nick, char *sender_address "default event", SERVER_REC, char *data, char *sender_nick, char *sender_address "whois default event", SERVER_REC, char *args, char *sender_nick, char *sender_address "server incoming", SERVER_REC, char *data + "server outgoing modify", SERVER_REC, GString *data, int crlf (for perl parser..) "redir ", SERVER_REC, char *args, char *sender_nick, char *sender_address @@ -241,12 +247,12 @@ FE common "gui print text", WINDOW_REC, int fg, int bg, int flags, char *text, TEXT_DEST_REC (Can be used to determine when all "gui print text"s are sent (not required)) - "gui print text finished", WINDOW_REC + "gui print text finished", WINDOW_REC, TEXT_DEST_REC * Provides signals: completion.c: - "complete word", GList * of char*, WINDOW_REC, char *word, char *linestart, int *want_space + "complete word", GList * of char *s, WINDOW_REC, char *word, char *linestart, int *want_space fe-common-core.c: "irssi init read settings" @@ -261,14 +267,18 @@ fe-messages.c: "message private", SERVER_REC, char *msg, char *nick, char *address, char *target "message own_public", SERVER_REC, char *msg, char *target "message own_private", SERVER_REC, char *msg, char *target, char *orig_target - "message join", SERVER_REC, char *channel, char *nick, char *address + "message join", SERVER_REC, char *channel, char *nick, char *address, char *account, char *realname "message part", SERVER_REC, char *channel, char *nick, char *address, char *reason "message quit", SERVER_REC, char *nick, char *address, char *reason "message kick", SERVER_REC, char *channel, char *nick, char *kicker, char *address, char *reason "message nick", SERVER_REC, char *newnick, char *oldnick, char *address "message own_nick", SERVER_REC, char *newnick, char *oldnick, char *address "message invite", SERVER_REC, char *channel, char *nick, char *address + "message invite_other", SERVER_REC, char *channel, char *invited, char *nick, char *address "message topic", SERVER_REC, char *channel, char *topic, char *nick, char *address + "message host_changed", SERVER_REC, char *nick, char *newaddress, char *oldaddress + "message account_changed", SERVER_REC, char *nick, char *address, char *account + "message away_notify", SERVER_REC, char *nick, char *address, char *awaymsg keyboard.c: "keyinfo created", KEYINFO_REC @@ -276,6 +286,8 @@ keyboard.c: printtext.c: "print text", TEXT_DEST_REC *dest, char *text, char *stripped + "print format", THEME_REC *theme, char *module, TEXT_DEST_REC *dest, formatnum_args + "print noformat", TEXT_DEST_REC *dest, char *text themes.c: "theme created", THEME_REC @@ -283,6 +295,7 @@ themes.c: window-activity.c: "window hilight", WINDOW_REC + "window hilight check", TEXT_DEST_REC, char *msg, int *data_level, int *should_ignore "window dehilight", WINDOW_REC "window activity", WINDOW_REC, int old_level "window item hilight", WI_ITEM_REC @@ -338,15 +351,25 @@ Text FE gui-readline.c: "gui key pressed", int key + "paste event", char *paste, char *arg gui-printtext.c: "beep" - "gui print text after finished", WINDOW_REC, LINE_REC *line, LINE_REC *prev_line + "gui print text after finished", WINDOW_REC, LINE_REC *line, LINE_REC *prev_line, TEXT_DEST_REC textbuffer-view.c "gui textbuffer line removed", TEXTBUFFER_VIEW_REC *view, LINE_REC *line, LINE_REC *prev_line +textbuffer-formats.c + "gui render line text", TEXT_DEST_REC, GString *str, LINE_INFO_META_REC + Perl ---- "script error", PERL_SCRIPT_REC, char *errormsg + +OTR Core +-------- + +otr.c: + "otr event", SERVER_REC, char *nick, char *status diff --git a/docs/special_vars.txt b/docs/special_vars.txt index 36517f78..1101c8a6 100644 --- a/docs/special_vars.txt +++ b/docs/special_vars.txt @@ -94,6 +94,8 @@ $A .. $Z is important. $winname window name $itemname like $T, but use item's visible_name which may be different (eg. $T = !12345chan, $itemname = !chan) + $abiversion IRSSI_ABI_VERSION + https://github.com/irssi/irssi/wiki/irssi_abi_version For example, assume you have the following alias: diff --git a/docs/startup-HOWTO.html b/docs/startup-HOWTO.html index 07a9f47c..787094d0 100644 --- a/docs/startup-HOWTO.html +++ b/docs/startup-HOWTO.html @@ -1,16 +1,13 @@ -

Startup How-To

-

To new Irssi users (not to new IRC users ..)

+ +

Startup How-To

+

To new Irssi users (not to new IRC users ..)

-

Copyright (c) 2000-2002 by Timo Sirainen, release under GNU FDL 1.1 license.

+

Copyright (c) 2000-2002 by Timo Sirainen, release under GNU FDL 1.1 license.

Index with some FAQ questions that are answered in the chapter:

    -
  1. For all the ircII people -
      -
    • This window management is just weird, I want it exactly like ircII
      • -
    -
    2. +
  2. First steps
  3. Basic user interface usage
    • Split windows work in weird way
      • @@ -50,7 +47,11 @@
  4. Proxies and IRC bouncers
    5. -
  5. Irssi’s settings
    6. +
  6. Irssi’s settings + +
  7. Statusbar
    • I loaded a statusbar script but it’s not visible anywhere!
      • @@ -58,169 +59,176 @@
-

1. For all the ircII people

+

1. First steps

-

These settings should give you pretty good defaults (the ones I use):

+

IRC Networks are made of servers, and servers have channels. The default config has a few predefined networks, to list them:

-

If colors don’t work, and you know you’re not going to use some weird non-VT compatible terminal (you most probably aren’t), just say:

+
/NETWORK LIST
+
-
 /SET term_force_colors ON
-
+

And to connect to one of those networks and join a channel:

-

I don’t like automatic query windows, I don’t like status window, I do like msgs window where all messages go:

+
/CONNECT liberachat
+/JOIN #irssi
+
-
 /SET autocreate_own_query OFF
- /SET autocreate_query_level DCCMSGS
- /SET use_status_window OFF
- /SET use_msgs_window ON
-
+

To add more networks:

-

Disable automatic window closing when /PARTing channel or /UNQUERYing query:

+
/NETWORK ADD ExampleNet
+
-
 /SET autoclose_windows OFF
- /SET reuse_unused_windows ON
-
+

Then add some servers (with -auto to automatically connect):

-

Here’s the settings that make irssi work exactly like ircII in window management (send me a note if you can think of more):

+
/SERVER ADD -auto -network ExampleNet irc.example.net
+
-
 /SET autocreate_own_query OFF
- /SET autocreate_query_level NONE
- /SET use_status_window OFF
- /SET use_msgs_window OFF
- /SET reuse_unused_windows ON
- /SET windows_auto_renumber OFF
+
Automatically join to channels after connected to server:

 
- /SET autostick_split_windows OFF
- /SET autoclose_windows OFF
- /SET print_active_channel ON
-
+
/CHANNEL ADD -auto #lounge ExampleNet
+
-

And example how to add servers:

+

To modify existing networks (or servers, or channels) just ADD again using the same name as before. This configures a network to identify with nickserv and wait for 2 seconds before joining channels:

-

(OFTC network, identify with nickserv and wait for 2 seconds before joining channels)

+
/NETWORK ADD -autosendcmd "/^msg nickserv ident pass;wait 2000" ExampleNet
+
-
 /NETWORK ADD -autosendcmd "/^msg nickserv ident pass;wait 2000" OFTC
-
+

If you have irssi 0.8.18 or higher and the irc network supports it, you can use SASL instead of nickserv, which is more reliable:

-

(NOTE: use /IRCNET with 0.8.9 and older)

+
/NETWORK ADD -sasl_username yourname -sasl_password yourpassword -sasl_mechanism PLAIN liberachat
+
-

Then add some servers to different networks (network is already set up for them), irc.kpnqwest.fi is used by default for IRCNet but if it fails, irc.funet.fi is tried next:

+

These commands have many more options, see their help for details:

-
 /SERVER ADD -auto -network IRCnet irc.kpnqwest.fi 6667
- /SERVER ADD -network IRCnet irc.funet.fi 6667
- /SERVER ADD -auto -network efnet efnet.cs.hut.fi 6667
-
- -

Automatically join to channels after connected to server, send op request to bot after joined to efnet/#irssi:

- -
 /CHANNEL ADD -auto #irssi IRCnet
- /CHANNEL ADD -auto -bots *!*bot@host.org -botcmd "/^msg $0 op pass" #irssi efnet
-
+
/HELP NETWORK
+/HELP SERVER
+/HELP CHANNEL
+/HELP
+

If you want lines containing your nick to hilight:

-
 /HILIGHT nick
-
+
/HILIGHT nick
+
+ +

Or, for irssi 0.8.18 or higher:

+ +
/SET hilight_nick_matches_everywhere ON
+
+ +

To get beeps on private messages or highlights:

+ +
/SET beep_msg_level MSGS HILIGHT DCCMSGS
+
+ +

No other irssi settings are needed (don’t enable bell_beeps), but there may be settings to change in your terminal multiplexer (screen/tmux), your terminal, or your desktop environment.

2. Basic user interface usage

Windows can be scrolled up/down with PgUp and PgDown keys. If they don’t work for you, use Meta-p and Meta-n keys. For jumping to beginning or end of the buffer, use /SB HOME and /SB END commands.

-

By default, irssi uses “hidden windows” for everything. Hidden window is created every time you /JOIN a channel or /QUERY someone. There’s several ways you can change between these windows:

+

By default, irssi uses “hidden windows” for everything. Hidden windows are created every time you /JOIN a channel or /QUERY someone. There’s several ways you can change between these windows:

-
 Meta-1, Meta-2, .. Meta-0 - Jump directly between windows 1-10
- Meta-q .. Meta-o          - Jump directly between windows 11-19
- /WINDOW <number>          - Jump to any window with specified number
- Ctrl-P, Ctrl-N            - Jump to previous / next window
-
+
Meta-1, Meta-2, .. Meta-0 - Jump directly between windows 1-10
+Meta-q .. Meta-o          - Jump directly between windows 11-19
+/WINDOW <number>          - Jump to any window with specified number
+Ctrl-P, Ctrl-N            - Jump to previous / next window
+
-

Clearly the easiest way is to use Meta-number keys. And what is the Meta key? ESC key always works as Meta, but there’s also easier ways. ALT could work as Meta, or if you have Windows keyboard, left Windows key might work as Meta. If they don’t work directly, you’ll need to set a few X resources (NOTE: these work with both xterm and rxvt):

+

Clearly the easiest way is to use Meta-number keys. Meta usually means the ALT key, but if that doesn’t work, you can use ESC.

-
 XTerm*eightBitInput:   false
+
Mac OS X users with ALT key issues might prefer using iTerm2 instead of the default terminal emulator.

+
+
Alt key as meta, for xterm/rxvt users

+
+
If you use xterm or rxvt, you may need to set a few X resources:

+
+
 XTerm*eightBitInput:   false
  XTerm*metaSendsEscape: true
-

+

With rxvt, you can also specify which key acts as Meta key. So if you want to use ALT instead of Windows key for it, use:

-
 rxvt*modifier: alt
-
+
 rxvt*modifier: alt
+

You could do this by changing the X key mappings:

-
 xmodmap -e "keysym Alt_L = Meta_L Alt_L"
-
+
 xmodmap -e "keysym Alt_L = Meta_L Alt_L"
+

And how exactly do you set these X resources? For Debian, there’s /etc/X11/Xresources/xterm file where you can put them and it’s read automatically when X starts. ~/.Xresources and ~/.Xdefaults files might also work. If you can’t get anything else to work, just copy and paste those lines to ~/.Xresources and directly call xrdb -merge ~/.Xresources in some xterm. The resources affect only the new xterms you start, not existing ones.

-

Many windows SSH clients also don’t allow usage of ALT. One excellent client that does allow is putty, you can download it from http://www.chiark.greenend.org.uk/~sgtatham/putty/.

+

Split windows and window items

+ +

Note: this guide might be a better introduction to window splits

Irssi also supports split windows, they’ve had some problems in past but I think they should work pretty well now :) Here’s some commands related to them:

-
 /WINDOW NEW                    - Create new split window
- /WINDOW NEW HIDE               - Create new hidden window
- /WINDOW CLOSE                  - Close split or hidden window
+
/WINDOW NEW                    - Create new split window
+/WINDOW NEW HIDE               - Create new hidden window
+/WINDOW CLOSE                  - Close split or hidden window
 
- /WINDOW HIDE [<number>|<name>] - Make the split window hidden window
- /WINDOW SHOW <number>|<name>   - Make the hidden window a split window
+/WINDOW HIDE [<number>|<name>] - Make the split window hidden window
+/WINDOW SHOW <number>|<name>   - Make the hidden window a split window
 
- /WINDOW SHRINK [<lines>]       - Shrink the split window
- /WINDOW GROW [<lines>]         - Grow the split window
- /WINDOW BALANCE                - Balance the sizes of all split windows
-

+/WINDOW SHRINK [<lines>]       - Shrink the split window
+/WINDOW GROW [<lines>]         - Grow the split window
+/WINDOW BALANCE                - Balance the sizes of all split windows
+

By default, irssi uses “sticky windowing” for split windows. This means that windows created inside one split window cannot be moved to another split window without some effort. For example you could have following window layout:

-
 Split window 1: win#1 - Status window, win#2 - Messages window
+
 Split window 1: win#1 - Status window, win#2 - Messages window
  Split window 2: win#3 - IRCnet/#channel1, win#4 - IRCnet/#channel2
  Split window 3: win#5 - efnet/#channel1, win#6 - efnet/#channel2
-

+

When you are in win#1 and press ALT-6, irssi jumps to split window #3 and moves the efnet/#channel2 the active window.

With non-sticky windowing the windows don’t have any relationship with split windows, pressing ALT-6 in win#1 moves win#6 to split window 1 and sets it active, except if win#6 was already visible in some other split window irssi just changes to that split window. This it the way windows work with ircii, if you prefer it you can set it with

-
 /SET autostick_split_windows OFF
-
+
/SET autostick_split_windows OFF
+

Each window can have multiple channels, queries and other “window items” inside them. If you don’t like windows at all, you disable automatic creating of them with

-
 /SET autocreate_windows OFF
-
+
/SET autocreate_windows OFF
+

And if you keep all channels in one window, you most probably want the channel name printed in each line:

-
 /SET print_active_channel ON
-
+
/SET print_active_channel ON
+

If you want to group only some channels or queries in one window, use

-
 /JOIN -window #channel
- /QUERY -window nick
-
+
/JOIN -window #channel
+/QUERY -window nick
+

3. Server and channel automation

Irssi’s multiple IRC network support is IMHO very good - at least compared to other clients :) Even if you’re only in one IRC network you should group all your servers to be in the same IRC network as this helps with reconnecting if your primary server breaks and is probably useful in some other ways too :) For information how to actually use irssi correctly with multiple servers see the chapter 6.

-

First you need to have your IRC network set, use /NETWORK command to see if it’s already there. If it isn’t, use /NETWORK ADD yournetwork. If you want to execute some commands automatically when you’re connected to some network, use -autosendcmd option. (NOTE: use /IRCNET with 0.8.9 and older.) Here’s some examples:

+

First you need to have your IRC network set, use /NETWORK command to see if it’s already there. If it isn’t, use /NETWORK ADD yournetwork. If you want to execute some commands automatically when you’re connected to some network, use -autosendcmd option. Here’s some examples:

-
 /NETWORK ADD -autosendcmd '^msg bot invite' IRCnet
- /NETWORK ADD -autosendcmd "/^msg nickserv ident pass;wait 2000" OFTC
-
+
/NETWORK ADD -autosendcmd '^msg bot invite' IRCnet
+/NETWORK ADD -autosendcmd "/^msg nickserv ident pass;wait 2000" OFTC
+

After that you need to add your servers. For example:

-
 /SERVER ADD -auto -network IRCnet irc.kpnqwest.fi 6667
- /SERVER ADD -auto -network worknet irc.mycompany.com 6667 password
-
+
/SERVER ADD -auto -network IRCnet irc.kpnqwest.fi 6667
+/SERVER ADD -auto -network worknet irc.mycompany.com 6667 password
+

The -auto option specifies that this server is automatically connected at startup. You don’t need to make more than one server with -auto option to one IRC network, other servers are automatically connected in same network if the -auto server fails.

And finally channels:

-
 /CHANNEL ADD -auto -bots *!*bot@host.org -botcmd "/^msg $0 op pass" #irssi efnet
- /CHANNEL ADD -auto #secret IRCnet password
-
+
/CHANNEL ADD -auto -bots *!*bot@host.org -botcmd "/^msg $0 op pass" #irssi efnet
+/CHANNEL ADD -auto #secret IRCnet password
+

-bots and -botcmd should be the only ones needing a bit of explaining. They’re used to send commands automatically to bot when channel is joined, usually to get ops automatically. You can specify multiple bot masks with -bots option separated with spaces (and remember to quote the string then). The $0 in -botcmd specifies the first found bot in the list. If you don’t need the bot masks (ie. the bot is always with the same nick, like chanserv) you can give only the -botcmd option and the command is always sent.

@@ -228,9 +236,9 @@

First connect to all the servers, join the channels and create the queries you want. If you want to move the windows or channels around use commands:

-
 /WINDOW MOVE LEFT/RIGHT/number    - move window elsewhere
- /WINDOW ITEM MOVE <number>|<name> - move channel/query to another window
-
+
/WINDOW MOVE LEFT/RIGHT/number    - move window elsewhere
+/WINDOW ITEM MOVE <number>|<name> - move channel/query to another window
+

When everything looks the way you like, use /LAYOUT SAVE command (and /SAVE, if you don’t have autosaving enabled) and when you start irssi next time, irssi remembers the positions of the channels, queries and everything. This “remembering” doesn’t mean that simply using /LAYOUT SAVE would automatically make irssi reconnect to all servers and join all channels, you’ll need the /SERVER ADD -auto and /CHANNEL ADD -auto commands to do that.

@@ -240,32 +248,32 @@

By default, all the “extra messages” go to status window. This means pretty much all messages that don’t clearly belong to some channel or query. Some people like it, some don’t. If you want to remove it, use

-
 /SET use_status_window OFF
-
+
/SET use_status_window OFF
+

This doesn’t have any effect until you restart irssi. If you want to remove it immediately, just /WINDOW CLOSE it.

Another common window is “messages window”, where all private messages go. By default it’s disabled and query windows are created instead. To make all private messages go to msgs window, say:

-
 /SET use_msgs_window ON
- /SET autocreate_query_level DCCMSGS  (or if you don't want queries to
+
/SET use_msgs_window ON
+/SET autocreate_query_level DCCMSGS  (or if you don't want queries to
  				      dcc chats either, say NONE)
-

+

use_msgs_window either doesn’t have any effect until restarting irssi. To create it immediately say:

-
 /WINDOW NEW HIDE     - create the window
- /WINDOW NAME (msgs)  - name it to "(msgs)"
- /WINDOW LEVEL MSGS   - make all private messages go to this window
- /WINDOW MOVE 1       - move it to first window
-
+
/WINDOW NEW HIDE     - create the window
+/WINDOW NAME (msgs)  - name it to "(msgs)"
+/WINDOW LEVEL MSGS   - make all private messages go to this window
+/WINDOW MOVE 1       - move it to first window
+

Note that neither use_msgs_window nor use_status_window have any effect at all if /LAYOUT SAVE has been used.

This brings us to message levels.. What are they? All messages that irssi prints have one or more “message levels”. Most common are PUBLIC for public messages in channels, MSGS for private messages and CRAP for all sorts of messages with no real classification. You can get a whole list of levels with

-
 /HELP levels
-
+
/HELP levels
+

Status window has message level ALL -MSGS, meaning that all messages, except private messages, without more specific place go to status window. The -MSGS is there so it doesn’t conflict with messages window.

@@ -273,15 +281,15 @@

ircii and several other clients support multiple servers by placing the connection into some window. IRSSI DOES NOT. There is no required relationship between window and server. You can connect to 10 servers and manage them all in just one window, or join channel in each one of them to one single window if you really want to. That being said, here’s how you do connect to new server without closing the old connection:

-
 /CONNECT irc.server.org
-
+
/CONNECT irc.server.org
+

Instead of the /SERVER which disconnects the existing connection. To see list of all active connections, use /SERVER without any parameters. You should see a list of something like:

-
 -!- IRCNet: irc.song.fi:6667 (IRCNet)
+
 -!- IRCNet: irc.song.fi:6667 (IRCNet)
  -!- OFTC: irc.oftc.net:6667 (OFTC)
  -!- RECON-1: 192.168.0.1:6667 () (02:59 left before reconnecting)
-

+

Here you see that we’re connected to IRCNet and OFTC networks. The IRCNet at the beginning is called the “server tag” while the (IRCnet) at the end shows the IRC network. Server tag specifies unique tag to refer to the server, usually it’s the same as the IRC network. When the IRC network isn’t known it’s some part of the server name. When there’s multiple connections to same IRC network or server, irssi adds a number after the tag so there could be network, network2, network3 etc.

@@ -289,63 +297,63 @@

To disconnect one of the servers, or to stop irssi from reconnecting, use

-
 /DISCONNECT network   - disconnect server with tag "network"
- /DISCONNECT recon-1  - stop trying to reconnect to RECON-1 server
- /RMRECONNS           - stop all server reconnections
+
/DISCONNECT network   - disconnect server with tag "network"
+/DISCONNECT recon-1  - stop trying to reconnect to RECON-1 server
+/RMRECONNS           - stop all server reconnections
 
- /RECONNECT recon-1   - immediately try reconnecting back to RECON-1
- /RECONNECT ALL       - immediately try reconnecting back to all
+/RECONNECT recon-1   - immediately try reconnecting back to RECON-1
+/RECONNECT ALL       - immediately try reconnecting back to all
  		       servers in reconnection queue
-

+

Now that you’re connected to all your servers, you’ll have to know how to specify which one of them you want to use. One way is to have an empty window, like status or msgs window. In it, you can specify which server to set active with

-
 /WINDOW SERVER tag    - set server "tag" active
- Ctrl-X                - set the next server in list active
-
+
/WINDOW SERVER tag    - set server "tag" active
+Ctrl-X                - set the next server in list active
+

When the server is active, you can use it normally. When there’s multiple connected servers, irssi adds [servertag] prefix to all messages in non-channel/query messages so you’ll know where it came from.

Several commands also accept -servertag option to specify which server it should use:

-
 /MSG -tag nick message
- /JOIN -tag #channel
- /QUERY -tag nick
-
+
/MSG -tag nick message
+/JOIN -tag #channel
+/QUERY -tag nick
+

/MSG tab completion also automatically adds the -tag option when nick isn’t in active server.

Window’s server can be made sticky. When sticky, it will never automatically change to anything else, and if server gets disconnected, the window won’t have any active server. When the server gets connected again, it is automatically set active in the window. To set the window’s server sticky use

-
 /WINDOW SERVER -sticky tag
-
+
/WINDOW SERVER -sticky tag
+

This is useful if you wish to have multiple status or msgs windows, one for each server. Here’s how to do them (repeat for each server)

-
 /WINDOW NEW HIDE
- /WINDOW NAME (status)
- /WINDOW LEVEL ALL -MSGS
- /WINDOW SERVER -sticky network
+
/WINDOW NEW HIDE
+/WINDOW NAME (status)
+/WINDOW LEVEL ALL -MSGS
+/WINDOW SERVER -sticky network
 
- /WINDOW NEW HIDE
- /WINDOW NAME (msgs)
- /WINDOW LEVEL MSGS
- /WINDOW SERVER -sticky network
-

+/WINDOW NEW HIDE
+/WINDOW NAME (msgs)
+/WINDOW LEVEL MSGS
+/WINDOW SERVER -sticky network
+

7. /LASTLOG and jumping around in scrollback

/LASTLOG command can be used for searching texts in scrollback buffer. Simplest usages are

-
 /LASTLOG word     - print all lines with "word" in them
- /LASTLOG word 10  - print last 10 occurances of "word"
- /LASTLOG -topics  - print all topic changes
-
+
/LASTLOG word     - print all lines with "word" in them
+/LASTLOG word 10  - print last 10 occurances of "word"
+/LASTLOG -topics  - print all topic changes
+

If there’s more than 1000 lines to be printed, irssi thinks that you probably made some mistake and won’t print them without -force option. If you want to save the full lastlog to file, use

-
 /LASTLOG -file ~/irc.log
-
+
/LASTLOG -file ~/irc.log
+

With -file option you don’t need -force even if there’s more than 1000 lines. /LASTLOG has a lot of other options too, see /HELP lastlog for details.

@@ -355,29 +363,29 @@

Irssi can automatically log important messages when you’re set away (/AWAY reason). When you set yourself unaway (/AWAY), the new messages in away log are printed to screen. You can configure it with:

-
 /SET awaylog_level MSGS HILIGHT     - Specifies what messages to log
- /SET awaylog_file ~/.irssi/away.log - Specifies the file to use
-
+
/SET awaylog_level MSGS HILIGHT     - Specifies what messages to log
+/SET awaylog_file ~/.irssi/away.log - Specifies the file to use
+

Easiest way to start logging with Irssi is to use autologging. With it Irssi logs all channels and private messages to specified directory. You can turn it on with

-
 /SET autolog ON
-
+
/SET autolog ON
+

By default it logs pretty much everything execept CTCPS or CRAP (/WHOIS requests, etc). You can specify the logging level yourself with

-
 /SET autolog_level ALL -CRAP -CLIENTCRAP -CTCPS (this is the default)
-
+
/SET autolog_level ALL -CRAP -CLIENTCRAP -CTCPS (this is the default)
+
-

By default irssi logs to ~/irclogs//.log. You can change this with

+

By default irssi logs to ~/irclogs/<servertag>/<target>.log. You can change this with

-
 /SET autolog_path ~/irclogs/$tag/$0.log (this is the default)
-
+
/SET autolog_path ~/irclogs/$tag/$0.log (this is the default)
+

The path is automatically created if it doesn’t exist. $0 specifies the target (channel/nick). You can make irssi automatically rotate the logs by adding date/time formats to the file name. The formats are in “man strftime” format. For example

-
 /SET autolog_path ~/irclogs/%Y/$tag/$0.%m-%d.log
-
+
/SET autolog_path ~/irclogs/%Y/$tag/$0.%m-%d.log
+

For logging only some specific channels or nicks, see /HELP log

@@ -387,37 +395,37 @@

/HELP bind tells pretty much everything there is to know about keyboard bindings. However, there’s the problem of how to bind some non-standard keys. They might differ a bit with each terminal, so you’ll need to find out what exactly the keypress produces. Easiest way to check that would be to see what it prints in cat. Here’s an example for pressing F1 key:

-
 [cras@hurina] ~% cat
+
 [cras@hurina] ~% cat
  ^[OP
-

+

So in irssi you would use /BIND ^[OP /ECHO F1 pressed. If you use multiple terminals which have different bindings for the key, it would be better to use eg.:

-
 /BIND ^[OP key F1
- /BIND ^[11~ key F1
- /BIND F1 /ECHO F1 pressed.
-
+
/BIND ^[OP key F1
+/BIND ^[11~ key F1
+/BIND F1 /ECHO F1 pressed.
+

10. Proxies and IRC bouncers

Irssi supports connecting to IRC servers via a proxy. All server connections are then made through it, and if you’ve set up everything properly, you don’t need to do any /QUOTE SERVER commands manually.

-

Here’s an example: You have your bouncer (lets say, BNC or BNC-like) listening in irc.bouncer.org port 5000. You want to use it to connect to servers irc.dalnet and irc.efnet.org. First you’d need to setup the bouncer:

+

Here’s an example: You have your bouncer (lets say, BNC or BNC-like) listening in irc.bouncer.org port 5000. You want to use it to connect to servers irc.dal.net and irc.efnet.org. First you’d need to setup the bouncer:

-
 /SET use_proxy ON
- /SET proxy_address irc.bouncer.org
- /SET proxy_port 5000
+
/SET use_proxy ON
+/SET proxy_address irc.bouncer.org
+/SET proxy_port 5000
 
- /SET proxy_password YOUR_BNC_PASSWORD_HERE
- /SET -clear proxy_string
- /SET proxy_string_after conn %s %d
-

+/SET proxy_password YOUR_BNC_PASSWORD_HERE
+/SET -clear proxy_string
+/SET proxy_string_after conn %s %d
+

Then you’ll need to add the server connections. These are done exactly as if you’d want to connect directly to them. Nothing special about them:

-
 /SERVER ADD -auto -network dalnet irc.dal.net
- /SERVER ADD -auto -network efnet irc.efnet.org
-
+
/SERVER ADD -auto -network dalnet irc.dal.net
+/SERVER ADD -auto -network efnet irc.efnet.org
+

With the proxy /SETs however, irssi now connects to those servers through your BNC. All server connections are made through them so you can just forget that your bouncer even exists.

@@ -425,38 +433,38 @@

Proxy specific settings:

-

All proxies have these settings in common:

+

All proxies except irssi proxy and socks proxy have these settings in common:

-
 /SET use_proxy ON
- /SET proxy_address <Proxy host address>
- /SET proxy_port <Proxy port>
-
+
/SET use_proxy ON
+/SET proxy_address <Proxy host address>
+/SET proxy_port <Proxy port>
+

HTTP proxy

Use these settings with HTTP proxies:

-
 /SET -clear proxy_password
- /EVAL SET proxy_string CONNECT %s:%d HTTP/1.0\n\n
-
+
/SET -clear proxy_password
+/EVAL SET proxy_string CONNECT %s:%d HTTP/1.0\n\n
+

BNC

-
 /SET proxy_password your_pass
- /SET -clear proxy_string
- /SET proxy_string_after conn %s %d
-
+
/SET proxy_password your_pass
+/SET -clear proxy_string
+/SET proxy_string_after conn %s %d
+

dircproxy

dircproxy separates the server connections by passwords. So, if you for example have network connection with password ircpass and OFTC connection with oftcpass, you would do something like this:

-
 /SET -clear proxy_password
- /SET -clear proxy_string
+
/SET -clear proxy_password
+/SET -clear proxy_string
 
- /SERVER ADD -auto -network IRCnet fake.network 6667 ircpass
- /SERVER ADD -auto -network OFTC fake.oftc 6667 oftcpass
-

+/SERVER ADD -auto -network IRCnet fake.network 6667 ircpass
+/SERVER ADD -auto -network OFTC fake.oftc 6667 oftcpass
+

The server name and port you give isn’t used anywhere, so you can put anything you want in there.

@@ -464,88 +472,73 @@

psyBNC has internal support for multiple servers. However, it could be a bit annoying to use, and some people just use different users for connecting to different servers. You can manage this in a bit same way as with dircproxy, by creating fake connections:

-
 /SET -clear proxy_password
- /SET -clear proxy_string
+
/SET -clear proxy_password
+/SET -clear proxy_string
 
- /NETWORK ADD -user networkuser IRCnet
- /SERVER ADD -auto -network IRCnet fake.network 6667 ircpass
- /NETWORK ADD -user oftcuser OFTC
- /SERVER ADD -auto -network OFTC fake.oftc 6667 oftcpass
-

+/NETWORK ADD -user networkuser IRCnet
+/SERVER ADD -auto -network IRCnet fake.network 6667 ircpass
+/NETWORK ADD -user oftcuser OFTC
+/SERVER ADD -auto -network OFTC fake.oftc 6667 oftcpass
+

So, you’ll specify the usernames with /NETWORK ADD command, and the user’s password with /SERVER ADD.

-

(NOTE: use /IRCNET with 0.8.9 and older.)

-

Irssi proxy

Irssi contains it’s own proxy which you can build giving \--with-proxy option to configure. You’ll still need to run irssi in a screen to use it though.

-

Irssi proxy is a bit different than most proxies, normally proxies create a new connection to IRC server when you connect to it, but irssi proxy shares your existing IRC connection(s) to multiple clients. And even more clearly: You can use only one IRC server connection to IRC with as many clients as you want. Can anyone figure out even more easier ways to say this, so I wouldn’t need to try to explain this thing for minutes every time? :)

+

Irssi proxy is a bit different than most proxies, normally proxies create a new connection to IRC server when a new client connects to it, but irssi proxy shares your existing IRC connection(s) to multiple clients. And even more clearly: You can use only one IRC server connection of the irssi proxy to IRC with as many clients as you want. Can anyone figure out even more easier ways to say this, so I wouldn’t need to try to explain this thing for minutes every time? :)

Irssi proxy supports sharing multiple server connections in different ports, like you can share network in port 2777 and efnet in port 2778.

Usage in proxy side:

-
 /LOAD proxy
- /SET irssiproxy_password <password>
- /SET irssiproxy_ports <network>=<port> ... (eg. IRCnet=2777 efnet=2778)
-
+
/LOAD proxy
+/SET irssiproxy_password <password>
+/SET irssiproxy_ports <network>=<port> ... (eg. IRCnet=2777 efnet=2778)
+

NOTE: you MUST add all the servers you are using to server and network lists with /SERVER ADD and /NETWORK ADD. ..Except if you really don’t want to for some reason, and you only use one server connection, you may simply set:

-
 /SET irssiproxy_ports *=2777
-
- -

The special network name ? allows the client to select the -network dynamically on connect (see below):

- -
-/SET irssiproxy_ports ?=2777
-
+
/SET irssiproxy_ports *=2777
+

Usage in client side:

Just connect to the irssi proxy like it is a normal server with password specified in /SET irssiproxy_password. For example:

-
 /SERVER ADD -network IRCnet my.irssi-proxy.org 2777 secret
- /SERVER ADD -network efnet my.irssi-proxy.org 2778 secret
-
- -

Or, if you used ? in irssiproxy_ports:

- -
-/SERVER ADD -network IRCnet my.irssi-proxy.org 2777 IRCnet:secret
-/SERVER ADD -network efnet my.irssi-proxy.org 2777 efnet:secret
-
- -

I.e. the network to connect to is specified as part of the password, -separated by : from the actual proxy password.

+
/SERVER ADD -network IRCnet my.irssi-proxy.org 2777 secret
+/SERVER ADD -network efnet my.irssi-proxy.org 2778 secret
+

Irssi proxy works fine with other IRC clients as well.

SOCKS

-

Irssi can be compiled with socks support (\--with-socks option to configure), but I don’t really know how it works, if at all. /SET proxy settings don’t have anything to do with socks however.

+

Using proxychains-ng is recommended for using irssi with a socks proxy.

+ +

Irssi does not support socks proxy natively.

+ +

Note that /SET proxy settings don’t have anything to do with socks.

Others

IRC bouncers usually work like IRC servers, and want a password. You can give it with:

-
 /SET proxy_password <password>
-
+
/SET proxy_password <password>
+

Irssi’s defaults for connect strings are

-
 /SET proxy_string CONNECT %s %d
- /SET proxy_string_after
-
+
/SET proxy_string CONNECT %s %d
+/SET proxy_string_after
+

The proxy_string is sent before NICK/USER commands, the proxy_string_after is sent after them. %s and %d can be used with both of them.

11. Irssi’s settings

-

You probably don’t like Irssi’s default settings. I don’t like them. But I’m still convinced that they’re pretty good defaults. Here’s some of them you might want to change (the default value is shown): Also check the Settings Documentation

+

Here’s some settings you might want to change (the default value is shown): Also check the Settings Documentation

Queries

@@ -633,31 +626,61 @@ separated by : from the actual proxy password.

Completion character to use.
+

For all the ircII people

+ +

I don’t like automatic query windows, I don’t like status window, I do like msgs window where all messages go:

+ +
/SET autocreate_own_query OFF
+/SET autocreate_query_level DCCMSGS
+/SET use_status_window OFF
+/SET use_msgs_window ON
+
+ +

Disable automatic window closing when /PARTing channel or /UNQUERYing query:

+ +
/SET autoclose_windows OFF
+/SET reuse_unused_windows ON
+
+ +

Here’s the settings that make irssi work exactly like ircII in window management (send me a note if you can think of more):

+ +
/SET autocreate_own_query OFF
+/SET autocreate_query_level NONE
+/SET use_status_window OFF
+/SET use_msgs_window OFF
+/SET reuse_unused_windows ON
+/SET windows_auto_renumber OFF
+
+/SET autostick_split_windows OFF
+/SET autoclose_windows OFF
+/SET print_active_channel ON
+
+

12. Statusbar

-

/STATUSBAR displays a list of statusbars:

+

/STATUSBAR displays a list of the current statusbars, along with their position and visibility:

-
 Name                           Type   Placement Position Visible
+
 Name                           Type   Placement Position Visible
  window                         window bottom    0        always
  window_inact                   window bottom    1        inactive
  prompt                         root   bottom    100      always
  topic                          root   top       1        always
-

+
-

/STATUSBAR <name> prints the statusbar settings and it’s items. /STATUSBAR <name> ENABLE|DISABLE enables/disables the statusbar. /STATUSBAR <name> RESET resets the statusbar to it’s default settings, or if the statusbar was created by you, it will be removed.

+

/STATUSBAR <name> prints the statusbar settings (type, placement, position, visibility) as well as its items. /STATUSBAR <name> ENABLE|DISABLE enables/disables the statusbar. /STATUSBAR <name> RESET resets the statusbar to its default settings, or if the statusbar was created by you, it will be removed.

-

Type can be window or root, meaning if the statusbar should be created for each split window, or just once. Placement can be top or bottom. Position is a number, the higher the value the lower in screen it is. Visible can be always, active or inactive. Active/inactive is useful only with split windows, one split window is active and the rest are inactive. These settings can be changed with:

+

The statusbar type can be either window or root. If the type is window, then a statusbar will be created for each split window, otherwise it will be created only once. Placement can be top or bottom, which refers to the top or bottom of the screen. Position is a number, the higher the value the lower it will appear in-screen. Visible can be always, active or inactive. Active/inactive is useful only with split windows; one split window is active and the rest are inactive. To adjust these settings, the following commands are available:

-
 /STATUSBAR <name> TYPE window|root
- /STATUSBAR <name> PLACEMENT top|bottom
- /STATUSBAR <name> POSITION <num>
- /STATUSBAR <name> VISIBLE always|active|inactive
-
+
/STATUSBAR <name> TYPE window|root
+/STATUSBAR <name> PLACEMENT top|bottom
+/STATUSBAR <name> POSITION <num>
+/STATUSBAR <name> VISIBLE always|active|inactive
+
-

When loading a new statusbar scripts, you’ll need to also specify where you want to show it. Statusbar items can be modified with:

+

Statusbar items can also be added or removed via command. Note that when loading new statusbar scripts that add items, you will need to specify where you want to show the item and how it is aligned. This can be accomplished using the below commands:

-
 /STATUSBAR <name> ADD [-before | -after <item>] [-priority #] [-alignment left|right] <item>
- /STATUSBAR <name> REMOVE <item>
-
+
/STATUSBAR <name> ADD [-before | -after <item>] [-priority #] [-alignment left|right] <item>
+/STATUSBAR <name> REMOVE <item>
+
-

The item name with statusbar scripts is usually same as the script’s name. Script’s documentation should tell if this isn’t the case. So, to add mail.pl before the window activity item (see the list with /STATUSBAR window), use: /STATUSBAR window ADD -before act mail.

+

For statusbar scripts, the item name is usually equivalent to the script name. The documentation of the script ought to tell you if this is not the case. For example, to add mail.pl before the window activity item, use: /STATUSBAR window ADD -before act mail.

diff --git a/docs/startup-HOWTO.txt b/docs/startup-HOWTO.txt new file mode 100644 index 00000000..5cc86af3 --- /dev/null +++ b/docs/startup-HOWTO.txt @@ -0,0 +1,796 @@ +Startup How-To + +To new Irssi users (not to new IRC users ..) + +Copyright (c) 2000-2002 by Timo Sirainen, release under [1]GNU FDL 1.1 license. + +Index with some FAQ questions that are answered in the chapter: + + 1. First steps + 2. Basic user interface usage + □ Split windows work in weird way + □ How can I easily switch between windows? + □ But alt-1 etc. don’t work! + 3. Server and channel automation + □ How do I automatically connect to servers at startup? + □ How do I automatically join to channels at startup? + □ How do I automatically send commands to server at connect? + 4. Setting up windows and automatically restoring them at startup + 5. Status and msgs windows & message levels + □ I want /WHOIS to print reply to current window + □ I want all messages to go to one window, not create new windows + 6. How support for multiple servers works in irssi + □ I connected to some server that doesn’t respond and now irssi keeps + trying to reconnect to it again and again, how can I stop it?? + □ I want to have own status and/or msgs window for each servers + 7. /LASTLOG and jumping around in scrollback + □ How can I save all texts in a window to file? + 8. Logging + 9. Changing keyboard bindings + □ How do I make F1 key do something? +10. Proxies and IRC bouncers +11. Irssi’s settings + □ For all the ircII people +12. Statusbar + □ I loaded a statusbar script but it’s not visible anywhere! + +1. First steps + +IRC Networks are made of servers, and servers have channels. The default config +has a few predefined networks, to list them: + +/NETWORK LIST + +And to connect to one of those networks and join a channel: + +/CONNECT liberachat +/JOIN #irssi + +To add more networks: + +/NETWORK ADD ExampleNet + +Then add some servers (with -auto to automatically connect): + +/SERVER ADD -auto -network ExampleNet irc.example.net + +Automatically join to channels after connected to server: + +/CHANNEL ADD -auto #lounge ExampleNet + +To modify existing networks (or servers, or channels) just ADD again using the +same name as before. This configures a network to identify with nickserv and +wait for 2 seconds before joining channels: + +/NETWORK ADD -autosendcmd "/^msg nickserv ident pass;wait 2000" ExampleNet + +If you have irssi 0.8.18 or higher and the irc network supports it, you can use +SASL instead of nickserv, which is more reliable: + +/NETWORK ADD -sasl_username yourname -sasl_password yourpassword -sasl_mechanism PLAIN liberachat + +These commands have many more options, see their help for details: + +/HELP NETWORK +/HELP SERVER +/HELP CHANNEL +/HELP + +If you want lines containing your nick to hilight: + +/HILIGHT nick + +Or, for irssi 0.8.18 or higher: + +/SET hilight_nick_matches_everywhere ON + +To get beeps on private messages or highlights: + +/SET beep_msg_level MSGS HILIGHT DCCMSGS + +No other irssi settings are needed (don’t enable bell_beeps), but there may be +settings to change in your terminal multiplexer (screen/tmux), your terminal, +or your desktop environment. + +2. Basic user interface usage + +Windows can be scrolled up/down with PgUp and PgDown keys. If they don’t work +for you, use Meta-p and Meta-n keys. For jumping to beginning or end of the +buffer, use /SB HOME and /SB END commands. + +By default, irssi uses “hidden windows” for everything. Hidden windows are +created every time you /JOIN a channel or /QUERY someone. There’s several ways +you can change between these windows: + +Meta-1, Meta-2, .. Meta-0 - Jump directly between windows 1-10 +Meta-q .. Meta-o - Jump directly between windows 11-19 +/WINDOW - Jump to any window with specified number +Ctrl-P, Ctrl-N - Jump to previous / next window + +Clearly the easiest way is to use Meta-number keys. Meta usually means the ALT +key, but if that doesn’t work, you can use ESC. + +Mac OS X users with ALT key issues might prefer using [2]iTerm2 instead of the +default terminal emulator. + +Alt key as meta, for xterm/rxvt users + +If you use xterm or rxvt, you may need to set a few X resources: + + XTerm*eightBitInput: false + XTerm*metaSendsEscape: true + +With rxvt, you can also specify which key acts as Meta key. So if you want to +use ALT instead of Windows key for it, use: + + rxvt*modifier: alt + +You could do this by changing the X key mappings: + + xmodmap -e "keysym Alt_L = Meta_L Alt_L" + +And how exactly do you set these X resources? For Debian, there’s /etc/X11/ +Xresources/xterm file where you can put them and it’s read automatically when X +starts. ~/.Xresources and ~/.Xdefaults files might also work. If you can’t get +anything else to work, just copy and paste those lines to ~/.Xresources and +directly call xrdb -merge ~/.Xresources in some xterm. The resources affect +only the new xterms you start, not existing ones. + +Split windows and window items + +Note: [3]this guide might be a better introduction to window splits + +Irssi also supports split windows, they’ve had some problems in past but I +think they should work pretty well now :) Here’s some commands related to them: + +/WINDOW NEW - Create new split window +/WINDOW NEW HIDE - Create new hidden window +/WINDOW CLOSE - Close split or hidden window + +/WINDOW HIDE [|] - Make the split window hidden window +/WINDOW SHOW | - Make the hidden window a split window + +/WINDOW SHRINK [] - Shrink the split window +/WINDOW GROW [] - Grow the split window +/WINDOW BALANCE - Balance the sizes of all split windows + +By default, irssi uses “sticky windowing” for split windows. This means that +windows created inside one split window cannot be moved to another split window +without some effort. For example you could have following window layout: + + Split window 1: win#1 - Status window, win#2 - Messages window + Split window 2: win#3 - IRCnet/#channel1, win#4 - IRCnet/#channel2 + Split window 3: win#5 - efnet/#channel1, win#6 - efnet/#channel2 + +When you are in win#1 and press ALT-6, irssi jumps to split window #3 and moves +the efnet/#channel2 the active window. + +With non-sticky windowing the windows don’t have any relationship with split +windows, pressing ALT-6 in win#1 moves win#6 to split window 1 and sets it +active, except if win#6 was already visible in some other split window irssi +just changes to that split window. This it the way windows work with ircii, if +you prefer it you can set it with + +/SET autostick_split_windows OFF + +Each window can have multiple channels, queries and other “window items” inside +them. If you don’t like windows at all, you disable automatic creating of them +with + +/SET autocreate_windows OFF + +And if you keep all channels in one window, you most probably want the channel +name printed in each line: + +/SET print_active_channel ON + +If you want to group only some channels or queries in one window, use + +/JOIN -window #channel +/QUERY -window nick + +3. Server and channel automation + +Irssi’s multiple IRC network support is IMHO very good - at least compared to +other clients :) Even if you’re only in one IRC network you should group all +your servers to be in the same IRC network as this helps with reconnecting if +your primary server breaks and is probably useful in some other ways too :) For +information how to actually use irssi correctly with multiple servers see the +chapter 6. + +First you need to have your IRC network set, use /NETWORK command to see if +it’s already there. If it isn’t, use /NETWORK ADD yournetwork. If you want to +execute some commands automatically when you’re connected to some network, use +-autosendcmd option. Here’s some examples: + +/NETWORK ADD -autosendcmd '^msg bot invite' IRCnet +/NETWORK ADD -autosendcmd "/^msg nickserv ident pass;wait 2000" OFTC + +After that you need to add your servers. For example: + +/SERVER ADD -auto -network IRCnet irc.kpnqwest.fi 6667 +/SERVER ADD -auto -network worknet irc.mycompany.com 6667 password + +The -auto option specifies that this server is automatically connected at +startup. You don’t need to make more than one server with -auto option to one +IRC network, other servers are automatically connected in same network if the +-auto server fails. + +And finally channels: + +/CHANNEL ADD -auto -bots *!*bot@host.org -botcmd "/^msg $0 op pass" #irssi efnet +/CHANNEL ADD -auto #secret IRCnet password + +-bots and -botcmd should be the only ones needing a bit of explaining. They’re +used to send commands automatically to bot when channel is joined, usually to +get ops automatically. You can specify multiple bot masks with -bots option +separated with spaces (and remember to quote the string then). The $0 in +-botcmd specifies the first found bot in the list. If you don’t need the bot +masks (ie. the bot is always with the same nick, like chanserv) you can give +only the -botcmd option and the command is always sent. + +4. Setting up windows and automatically restoring them at startup + +First connect to all the servers, join the channels and create the queries you +want. If you want to move the windows or channels around use commands: + +/WINDOW MOVE LEFT/RIGHT/number - move window elsewhere +/WINDOW ITEM MOVE | - move channel/query to another window + +When everything looks the way you like, use /LAYOUT SAVE command (and /SAVE, if +you don’t have autosaving enabled) and when you start irssi next time, irssi +remembers the positions of the channels, queries and everything. This +“remembering” doesn’t mean that simply using /LAYOUT SAVE would automatically +make irssi reconnect to all servers and join all channels, you’ll need the / +SERVER ADD -auto and /CHANNEL ADD -auto commands to do that. + +If you want to change the layout, you just rearrange the layout like you want +it and use /LAYOUT SAVE again. If you want to remove the layout for some +reason, use /LAYOUT RESET. + +5. Status and msgs windows & message levels + +By default, all the “extra messages” go to status window. This means pretty +much all messages that don’t clearly belong to some channel or query. Some +people like it, some don’t. If you want to remove it, use + +/SET use_status_window OFF + +This doesn’t have any effect until you restart irssi. If you want to remove it +immediately, just /WINDOW CLOSE it. + +Another common window is “messages window”, where all private messages go. By +default it’s disabled and query windows are created instead. To make all +private messages go to msgs window, say: + +/SET use_msgs_window ON +/SET autocreate_query_level DCCMSGS (or if you don't want queries to + dcc chats either, say NONE) + +use_msgs_window either doesn’t have any effect until restarting irssi. To +create it immediately say: + +/WINDOW NEW HIDE - create the window +/WINDOW NAME (msgs) - name it to "(msgs)" +/WINDOW LEVEL MSGS - make all private messages go to this window +/WINDOW MOVE 1 - move it to first window + +Note that neither use_msgs_window nor use_status_window have any effect at all +if /LAYOUT SAVE has been used. + +This brings us to message levels.. What are they? All messages that irssi +prints have one or more “message levels”. Most common are PUBLIC for public +messages in channels, MSGS for private messages and CRAP for all sorts of +messages with no real classification. You can get a whole list of levels with + +/HELP levels + +Status window has message level ALL -MSGS, meaning that all messages, except +private messages, without more specific place go to status window. The -MSGS is +there so it doesn’t conflict with messages window. + +6. How support for multiple servers works in irssi + +ircii and several other clients support multiple servers by placing the +connection into some window. IRSSI DOES NOT. There is no required relationship +between window and server. You can connect to 10 servers and manage them all in +just one window, or join channel in each one of them to one single window if +you really want to. That being said, here’s how you do connect to new server +without closing the old connection: + +/CONNECT irc.server.org + +Instead of the /SERVER which disconnects the existing connection. To see list +of all active connections, use /SERVER without any parameters. You should see a +list of something like: + + -!- IRCNet: irc.song.fi:6667 (IRCNet) + -!- OFTC: irc.oftc.net:6667 (OFTC) + -!- RECON-1: 192.168.0.1:6667 () (02:59 left before reconnecting) + +Here you see that we’re connected to IRCNet and OFTC networks. The IRCNet at +the beginning is called the “server tag” while the (IRCnet) at the end shows +the IRC network. Server tag specifies unique tag to refer to the server, +usually it’s the same as the IRC network. When the IRC network isn’t known it’s +some part of the server name. When there’s multiple connections to same IRC +network or server, irssi adds a number after the tag so there could be network, +network2, network3 etc. + +Server tags beginning with RECON- mean server reconnections. Above we see that +connection to server at 192.168.0.1 wasn’t successful and irssi will try to +connect it again in 3 minutes. + +To disconnect one of the servers, or to stop irssi from reconnecting, use + +/DISCONNECT network - disconnect server with tag "network" +/DISCONNECT recon-1 - stop trying to reconnect to RECON-1 server +/RMRECONNS - stop all server reconnections + +/RECONNECT recon-1 - immediately try reconnecting back to RECON-1 +/RECONNECT ALL - immediately try reconnecting back to all + servers in reconnection queue + +Now that you’re connected to all your servers, you’ll have to know how to +specify which one of them you want to use. One way is to have an empty window, +like status or msgs window. In it, you can specify which server to set active +with + +/WINDOW SERVER tag - set server "tag" active +Ctrl-X - set the next server in list active + +When the server is active, you can use it normally. When there’s multiple +connected servers, irssi adds [servertag] prefix to all messages in non-channel +/query messages so you’ll know where it came from. + +Several commands also accept -servertag option to specify which server it +should use: + +/MSG -tag nick message +/JOIN -tag #channel +/QUERY -tag nick + +/MSG tab completion also automatically adds the -tag option when nick isn’t in +active server. + +Window’s server can be made sticky. When sticky, it will never automatically +change to anything else, and if server gets disconnected, the window won’t have +any active server. When the server gets connected again, it is automatically +set active in the window. To set the window’s server sticky use + +/WINDOW SERVER -sticky tag + +This is useful if you wish to have multiple status or msgs windows, one for +each server. Here’s how to do them (repeat for each server) + +/WINDOW NEW HIDE +/WINDOW NAME (status) +/WINDOW LEVEL ALL -MSGS +/WINDOW SERVER -sticky network + +/WINDOW NEW HIDE +/WINDOW NAME (msgs) +/WINDOW LEVEL MSGS +/WINDOW SERVER -sticky network + +7. /LASTLOG and jumping around in scrollback + +/LASTLOG command can be used for searching texts in scrollback buffer. Simplest +usages are + +/LASTLOG word - print all lines with "word" in them +/LASTLOG word 10 - print last 10 occurances of "word" +/LASTLOG -topics - print all topic changes + +If there’s more than 1000 lines to be printed, irssi thinks that you probably +made some mistake and won’t print them without -force option. If you want to +save the full lastlog to file, use + +/LASTLOG -file ~/irc.log + +With -file option you don’t need -force even if there’s more than 1000 lines. / +LASTLOG has a lot of other options too, see /HELP lastlog for details. + +Once you’ve found the lines you were interested in, you might want to check the +discussion around them. Irssi has /SCROLLBACK (or alias /SB) command for +jumping around in scrollback buffer. Since /LASTLOG prints the timestamp when +the message was originally printed, you can use /SB GOTO hh:mm to jump directly +there. To get back to the bottom of scrollback, use /SB END command. + +8. Logging + +Irssi can automatically log important messages when you’re set away (/AWAY +reason). When you set yourself unaway (/AWAY), the new messages in away log are +printed to screen. You can configure it with: + +/SET awaylog_level MSGS HILIGHT - Specifies what messages to log +/SET awaylog_file ~/.irssi/away.log - Specifies the file to use + +Easiest way to start logging with Irssi is to use autologging. With it Irssi +logs all channels and private messages to specified directory. You can turn it +on with + +/SET autolog ON + +By default it logs pretty much everything execept CTCPS or CRAP (/WHOIS +requests, etc). You can specify the logging level yourself with + +/SET autolog_level ALL -CRAP -CLIENTCRAP -CTCPS (this is the default) + +By default irssi logs to ~/irclogs//.log. You can change +this with + +/SET autolog_path ~/irclogs/$tag/$0.log (this is the default) + +The path is automatically created if it doesn’t exist. $0 specifies the target +(channel/nick). You can make irssi automatically rotate the logs by adding date +/time formats to the file name. The formats are in “man strftime” format. For +example + +/SET autolog_path ~/irclogs/%Y/$tag/$0.%m-%d.log + +For logging only some specific channels or nicks, see /HELP log + +9. Changing keyboard bindings + +You can change any keyboard binding that terminal lets irssi know about. It +doesn’t let irssi know everything, so for example shift-backspace can’t be +bound unless you modify xterm resources somehow. + +/HELP bind tells pretty much everything there is to know about keyboard +bindings. However, there’s the problem of how to bind some non-standard keys. +They might differ a bit with each terminal, so you’ll need to find out what +exactly the keypress produces. Easiest way to check that would be to see what +it prints in cat. Here’s an example for pressing F1 key: + + [cras@hurina] ~% cat + ^[OP + +So in irssi you would use /BIND ^[OP /ECHO F1 pressed. If you use multiple +terminals which have different bindings for the key, it would be better to use +eg.: + +/BIND ^[OP key F1 +/BIND ^[11~ key F1 +/BIND F1 /ECHO F1 pressed. + +10. Proxies and IRC bouncers + +Irssi supports connecting to IRC servers via a proxy. All server connections +are then made through it, and if you’ve set up everything properly, you don’t +need to do any /QUOTE SERVER commands manually. + +Here’s an example: You have your bouncer (lets say, BNC or BNC-like) listening +in irc.bouncer.org port 5000. You want to use it to connect to servers +irc.dal.net and irc.efnet.org. First you’d need to setup the bouncer: + +/SET use_proxy ON +/SET proxy_address irc.bouncer.org +/SET proxy_port 5000 + +/SET proxy_password YOUR_BNC_PASSWORD_HERE +/SET -clear proxy_string +/SET proxy_string_after conn %s %d + +Then you’ll need to add the server connections. These are done exactly as if +you’d want to connect directly to them. Nothing special about them: + +/SERVER ADD -auto -network dalnet irc.dal.net +/SERVER ADD -auto -network efnet irc.efnet.org + +With the proxy /SETs however, irssi now connects to those servers through your +BNC. All server connections are made through them so you can just forget that +your bouncer even exists. + +If you don’t want to use the proxy for some reason, there’s -noproxy option +which you can give to /SERVER and /SERVER ADD commands. + +Proxy specific settings: + +All proxies except irssi proxy and socks proxy have these settings in common: + +/SET use_proxy ON +/SET proxy_address +/SET proxy_port + +HTTP proxy + +Use these settings with HTTP proxies: + +/SET -clear proxy_password +/EVAL SET proxy_string CONNECT %s:%d HTTP/1.0\n\n + +BNC + +/SET proxy_password your_pass +/SET -clear proxy_string +/SET proxy_string_after conn %s %d + +dircproxy + +dircproxy separates the server connections by passwords. So, if you for example +have network connection with password ircpass and OFTC connection with +oftcpass, you would do something like this: + +/SET -clear proxy_password +/SET -clear proxy_string + +/SERVER ADD -auto -network IRCnet fake.network 6667 ircpass +/SERVER ADD -auto -network OFTC fake.oftc 6667 oftcpass + +The server name and port you give isn’t used anywhere, so you can put anything +you want in there. + +psyBNC + +psyBNC has internal support for multiple servers. However, it could be a bit +annoying to use, and some people just use different users for connecting to +different servers. You can manage this in a bit same way as with dircproxy, by +creating fake connections: + +/SET -clear proxy_password +/SET -clear proxy_string + +/NETWORK ADD -user networkuser IRCnet +/SERVER ADD -auto -network IRCnet fake.network 6667 ircpass +/NETWORK ADD -user oftcuser OFTC +/SERVER ADD -auto -network OFTC fake.oftc 6667 oftcpass + +So, you’ll specify the usernames with /NETWORK ADD command, and the user’s +password with /SERVER ADD. + +Irssi proxy + +Irssi contains it’s own proxy which you can build giving \--with-proxy option +to configure. You’ll still need to run irssi in a screen to use it though. + +Irssi proxy is a bit different than most proxies, normally proxies create a new +connection to IRC server when a new client connects to it, but irssi proxy +shares your existing IRC connection(s) to multiple clients. And even more +clearly: You can use only one IRC server connection of the irssi proxy to IRC +with as many clients as you want. Can anyone figure out even more easier ways +to say this, so I wouldn’t need to try to explain this thing for minutes every +time? :) + +Irssi proxy supports sharing multiple server connections in different ports, +like you can share network in port 2777 and efnet in port 2778. + +Usage in proxy side: + +/LOAD proxy +/SET irssiproxy_password +/SET irssiproxy_ports = ... (eg. IRCnet=2777 efnet=2778) + +NOTE: you MUST add all the servers you are using to server and network lists +with /SERVER ADD and /NETWORK ADD. ..Except if you really don’t want to for +some reason, and you only use one server connection, you may simply set: + +/SET irssiproxy_ports *=2777 + +Usage in client side: + +Just connect to the irssi proxy like it is a normal server with password +specified in /SET irssiproxy_password. For example: + +/SERVER ADD -network IRCnet my.irssi-proxy.org 2777 secret +/SERVER ADD -network efnet my.irssi-proxy.org 2778 secret + +Irssi proxy works fine with other IRC clients as well. + +SOCKS + +Using [4]proxychains-ng is recommended for using irssi with a socks proxy. + +Irssi does not support socks proxy natively. + +Note that /SET proxy settings don’t have anything to do with socks. + +Others + +IRC bouncers usually work like IRC servers, and want a password. You can give +it with: + +/SET proxy_password + +Irssi’s defaults for connect strings are + +/SET proxy_string CONNECT %s %d +/SET proxy_string_after + +The proxy_string is sent before NICK/USER commands, the proxy_string_after is +sent after them. %s and %d can be used with both of them. + +11. Irssi’s settings + +Here’s some settings you might want to change (the default value is shown): +Also check the [5]Settings Documentation + +Queries + +/SET autocreate_own_query ON + Should new query window be created when you send message to someone (with / + MSG). +/SET autocreate_query_level MSGS + New query window should be created when receiving messages with this level. + MSGS, DCCMSGS and NOTICES levels work currently. You can disable this with + /SET -clear autocreate_query_level. +/SET autoclose_query 0 + Query windows can be automatically closed after certain time of inactivity. + Queries with unread messages aren’t closed and active window is neither + never closed. The value is given in seconds. + +Windows + +/SET use_msgs_window OFF + Create messages window at startup. All private messages go to this window. + This only makes sense if you’ve disabled automatic query windows. Message + window can also be created manually with /WINDOW LEVEL MSGS, /WINDOW NAME + (msgs). +/SET use_status_window ON + Create status window at startup. All messages that don’t really have better + place go here, like all /WHOIS replies etc. Status window can also be + created manually with /WINDOW LEVEL ALL -MSGS, /WINDOW NAME (status). +/SET autocreate_windows ON + Should we create new windows for new window items or just place everything + in one window +/SET autoclose_windows ON + Should window be automatically closed when the last item in them is removed + (ie. /PART, /UNQUERY). +/SET reuse_unused_windows OFF + When finding where to place new window item (channel, query) Irssi first + tries to use already existing empty windows. If this is set ON, new window + will always be created for all window items. This setting is ignored if + autoclose_windows is set ON. +/SET window_auto_change OFF + Should Irssi automatically change to automatically created windows - + usually queries when someone sends you a message. To prevent accidentally + sending text meant to some other channel/nick, Irssi clears the input + buffer when changing the window. The text is still in scrollback buffer, + you can get it back with pressing arrow up key. +/SET print_active_channel OFF + When you keep more than one channel in same window, Irssi prints the + messages coming to active channel as text and other channels as + text. If this setting is set ON, the messages to active + channels are also printed in the latter way. +/SET window_history OFF + Should command history be kept separate for each window. + +User information + +/SET nick + Your nick name +/SET alternate_nick + Your alternate nick. +/SET user_name + Your username, if you have ident enabled this doesn’t affect anything +/SET real_name + Your real name. + +Server information + +/SET skip_motd OFF + Should we hide server’s MOTD (Message Of The Day). +/SET server_reconnect_time 300 + Seconds to wait before connecting to same server again. Don’t set this too + low since it usually doesn’t help at all - if the host is down, the few + extra minutes of waiting won’t hurt much. +/SET lag_max_before_disconnect 300 + Maximum server lag in seconds before disconnecting and trying to reconnect. + This happens mostly only when network breaks between you and IRC server. + +Appearance + +/SET timestamps ON + Show timestamps before each message. +/SET hide_text_style OFF + Hide all bolds, underlines, MIRC colors, etc. +/SET show_nickmode ON + Show the nick’s mode before nick in channels, ie. ops have <@nick>, voices + <+nick> and others < nick> +/SET show_nickmode_empty ON + If the nick doesn’t have a mode, use one space. ie. ON: < nick>, OFF: + +/SET show_quit_once OFF + Show quit message only once in some of the channel windows the nick was in + instead of in all windows. +/SET lag_min_show 100 + Show the server lag in status bar if it’s bigger than this, the unit is 1/ + 100 of seconds (ie. the default value of 100 = 1 second). +/SET indent 10 + When lines are longer than screen width they have to be split to multiple + lines. This specifies how much space to put at the beginning of the line + before the text begins. This can be overridden in text formats with %| + format. +/SET activity_hide_targets + If you don’t want to see window activity in some certain channels or + queries, list them here. For example #boringchannel =bot1 =bot2. If any + highlighted text or message for you appears in that window, this setting is + ignored and the activity is shown. + +Nick completion + +/SET completion_auto OFF + Automatically complete the nick if line begins with start of nick and the + completion character. Learn to use the tab-completion instead, it’s a lot + better ;) +/SET completion_char : + Completion character to use. + +For all the ircII people + +I don’t like automatic query windows, I don’t like status window, I do like +msgs window where all messages go: + +/SET autocreate_own_query OFF +/SET autocreate_query_level DCCMSGS +/SET use_status_window OFF +/SET use_msgs_window ON + +Disable automatic window closing when /PARTing channel or /UNQUERYing query: + +/SET autoclose_windows OFF +/SET reuse_unused_windows ON + +Here’s the settings that make irssi work exactly like ircII in window +management (send me a note if you can think of more): + +/SET autocreate_own_query OFF +/SET autocreate_query_level NONE +/SET use_status_window OFF +/SET use_msgs_window OFF +/SET reuse_unused_windows ON +/SET windows_auto_renumber OFF + +/SET autostick_split_windows OFF +/SET autoclose_windows OFF +/SET print_active_channel ON + +12. Statusbar + +/STATUSBAR displays a list of the current statusbars, along with their position +and visibility: + + Name Type Placement Position Visible + window window bottom 0 always + window_inact window bottom 1 inactive + prompt root bottom 100 always + topic root top 1 always + +/STATUSBAR prints the statusbar settings (type, placement, position, +visibility) as well as its items. /STATUSBAR ENABLE|DISABLE enables/ +disables the statusbar. /STATUSBAR RESET resets the statusbar to its +default settings, or if the statusbar was created by you, it will be removed. + +The statusbar type can be either window or root. If the type is window, then a +statusbar will be created for each split window, otherwise it will be created +only once. Placement can be top or bottom, which refers to the top or bottom of +the screen. Position is a number, the higher the value the lower it will appear +in-screen. Visible can be always, active or inactive. Active/inactive is useful +only with split windows; one split window is active and the rest are inactive. +To adjust these settings, the following commands are available: + +/STATUSBAR TYPE window|root +/STATUSBAR PLACEMENT top|bottom +/STATUSBAR POSITION +/STATUSBAR VISIBLE always|active|inactive + +Statusbar items can also be added or removed via command. Note that when +loading new statusbar scripts that add items, you will need to specify where +you want to show the item and how it is aligned. This can be accomplished using +the below commands: + +/STATUSBAR ADD [-before | -after ] [-priority #] [-alignment left|right] +/STATUSBAR REMOVE + +For statusbar scripts, the item name is usually equivalent to the script name. +The documentation of the script ought to tell you if this is not the case. For +example, to add mail.pl before the window activity item, use: /STATUSBAR window +ADD -before act mail. + + +References: + +[1] https://www.gnu.org/licenses/fdl.html +[2] https://www.iterm2.com/ +[3] https://quadpoint.org/articles/irssisplit/ +[4] https://github.com/rofl0r/proxychains-ng +[5] https://irssi.org/documentation/settings/ diff --git a/file2header.sh b/file2header.sh deleted file mode 100755 index f25ae13b..00000000 --- a/file2header.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/sh - -echo "const char *$2 =" -cat $1|sed 's/\\/\\\\/g'|sed 's/"/\\"/g'|sed 's/^/\"/'|sed 's/$/\\n\"/' -echo ";" diff --git a/fuzz-support/fuzz.diff b/fuzz-support/fuzz.diff new file mode 100644 index 00000000..5a3f2176 --- /dev/null +++ b/fuzz-support/fuzz.diff @@ -0,0 +1,269 @@ +diff --git a/src/core/network.c b/src/core/network.c +index 3e1b7c7..1e5324a 100644 +--- a/src/core/network.c ++++ b/src/core/network.c +@@ -199,6 +199,10 @@ GIOChannel *net_connect_ip(IPADDR *ip, int port, IPADDR *my_ip) + /* Connect to named UNIX socket */ + GIOChannel *net_connect_unix(const char *path) + { ++ if (strcmp(path, "/dev/stdin") == 0) { ++ return g_io_channel_new(0); ++ } ++ + struct sockaddr_un sa; + int handle, ret; + +@@ -336,6 +340,8 @@ int net_receive(GIOChannel *handle, char *buf, int len) + /* Transmit data, return number of bytes sent, -1 = error */ + int net_transmit(GIOChannel *handle, const char *data, int len) + { ++ return write(1, data, len); ++ + gsize ret; + GIOStatus status; + GError *err = NULL; +@@ -495,6 +501,7 @@ int net_host2ip(const char *host, IPADDR *ip) + /* Get socket error */ + int net_geterror(GIOChannel *handle) + { ++ return 0; + int data; + socklen_t len = sizeof(data); + +diff --git a/src/core/servers-reconnect.c b/src/core/servers-reconnect.c +index 58c9dd0..0c6ec1b 100644 +--- a/src/core/servers-reconnect.c ++++ b/src/core/servers-reconnect.c +@@ -484,7 +484,8 @@ void servers_reconnect_init(void) + reconnects = NULL; + last_reconnect_tag = 0; + +- reconnect_timeout_tag = g_timeout_add(1000, (GSourceFunc) server_reconnect_timeout, NULL); ++ (void) server_reconnect_timeout; ++ + read_settings(); + + signal_add("server connect failed", (SIGNAL_FUNC) sig_reconnect); +diff --git a/src/core/settings.c b/src/core/settings.c +index e65ceb2..f9dc678 100644 +--- a/src/core/settings.c ++++ b/src/core/settings.c +@@ -704,7 +704,10 @@ int irssi_config_is_changed(const char *fname) + + static CONFIG_REC *parse_configfile(const char *fname) + { +- CONFIG_REC *config; ++ CONFIG_REC *config = config_open(NULL, -1); ++ config_parse_data(config, default_config, "internal"); ++ return config; ++ + struct stat statbuf; + const char *path; + char *str; +@@ -871,8 +874,6 @@ void settings_init(void) + init_configfile(); + + settings_add_bool("misc", "settings_autosave", TRUE); +- timeout_tag = g_timeout_add(SETTINGS_AUTOSAVE_TIMEOUT, +- (GSourceFunc) sig_autosave, NULL); + signal_add("irssi init finished", (SIGNAL_FUNC) sig_init_finished); + signal_add("gui exit", (SIGNAL_FUNC) sig_autosave); + } +diff --git a/src/fe-common/core/fe-common-core.c b/src/fe-common/core/fe-common-core.c +index 1b2ab1e..4344cd9 100644 +--- a/src/fe-common/core/fe-common-core.c ++++ b/src/fe-common/core/fe-common-core.c +@@ -320,6 +320,8 @@ static void autoconnect_servers(void) + GSList *tmp, *chatnets; + char *str; + ++ return; ++ + if (autocon_server != NULL) { + /* connect to specified server */ + if (autocon_password == NULL) +@@ -390,6 +392,7 @@ static void sig_setup_changed(void) + + static void autorun_startup(void) + { ++ return; + char *path; + GIOChannel *handle; + GString *buf; +diff --git a/src/fe-common/core/themes.c b/src/fe-common/core/themes.c +index 2b1459b..2e518a1 100644 +--- a/src/fe-common/core/themes.c ++++ b/src/fe-common/core/themes.c +@@ -790,9 +790,8 @@ static void theme_read_module(THEME_REC *theme, const char *module) + { + CONFIG_REC *config; + +- config = config_open(theme->path, -1); +- if (config != NULL) +- config_parse(config); ++ config = config_open(NULL, -1); ++ config_parse_data(config, default_theme, "internal"); + + theme_init_module(theme, module, config); + +@@ -987,7 +986,7 @@ static int theme_read(THEME_REC *theme, const char *path) + THEME_READ_REC rec; + char *str; + +- config = config_open(path, -1) ; ++ config = config_open(NULL, -1) ; + if (config == NULL) { + /* didn't exist or no access? */ + str = g_strdup_printf("Error reading theme file %s: %s", +@@ -997,7 +996,7 @@ static int theme_read(THEME_REC *theme, const char *path) + return FALSE; + } + +- if (path == NULL) ++ if (1) + config_parse_data(config, default_theme, "internal"); + else + config_parse(config); +@@ -1200,6 +1199,7 @@ static void module_save(const char *module, MODULE_THEME_REC *rec, + + static void theme_save(THEME_REC *theme, int save_all) + { ++ return; + CONFIG_REC *config; + THEME_SAVE_REC data; + char *path; +diff --git a/src/fe-text/gui-readline.c b/src/fe-text/gui-readline.c +index 7c71edd..6bf2177 100644 +--- a/src/fe-text/gui-readline.c ++++ b/src/fe-text/gui-readline.c +@@ -1126,7 +1126,6 @@ void gui_readline_init(void) + paste_timeout_id = -1; + paste_bracketed_mode = FALSE; + g_get_current_time(&last_keypress); +- input_listen_init(STDIN_FILENO); + + settings_add_bool("lookandfeel", "term_appkey_mode", TRUE); + settings_add_str("history", "scroll_page_count", "/2"); +diff --git a/src/fe-text/irssi.c b/src/fe-text/irssi.c +index ad79e0c..84d0c5c 100644 +--- a/src/fe-text/irssi.c ++++ b/src/fe-text/irssi.c +@@ -314,20 +314,16 @@ int main(int argc, char **argv) + textui_finish_init(); + main_loop = g_main_loop_new(NULL, TRUE); + ++#ifdef __AFL_HAVE_MANUAL_CONTROL ++ __AFL_INIT(); ++#endif ++ ++ signal_emit("command connect", 1, "/dev/stdin 6667"); ++ + /* Does the same as g_main_run(main_loop), except we + can call our dirty-checker after each iteration */ + while (!quitting) { +- term_refresh_freeze(); + g_main_context_iteration(NULL, TRUE); +- term_refresh_thaw(); +- +- if (reload_config) { +- /* SIGHUP received, do /RELOAD */ +- reload_config = FALSE; +- signal_emit("command reload", 1, ""); +- } +- +- dirty_check(); + } + + g_main_loop_unref(main_loop); +diff --git a/src/fe-text/term-terminfo.c b/src/fe-text/term-terminfo.c +index b2478c6..cebe260 100644 +--- a/src/fe-text/term-terminfo.c ++++ b/src/fe-text/term-terminfo.c +@@ -29,6 +29,10 @@ + #include + #include + ++#undef putc ++#define putc(x, y) (void) (x) ++#define fputc(x, y) (void) (x), 0 ++ + /* returns number of characters in the beginning of the buffer being a + a single character, or -1 if more input is needed. The character will be + saved in result */ +@@ -113,7 +117,8 @@ int term_init(void) + vcmove = FALSE; cforcemove = TRUE; + curs_visible = TRUE; + +- current_term = terminfo_core_init(stdin, stdout); ++ FILE *devnull = fopen("/dev/null", "r+"); ++ current_term = terminfo_core_init(devnull, devnull); + if (current_term == NULL) + return FALSE; + +@@ -670,6 +675,7 @@ void term_set_input_type(int type) + + void term_gets(GArray *buffer, int *line_count) + { ++ return; + int ret, i, char_len; + + /* fread() doesn't work */ +diff --git a/src/fe-text/terminfo-core.c b/src/fe-text/terminfo-core.c +index 9c9179a..6349935 100644 +--- a/src/fe-text/terminfo-core.c ++++ b/src/fe-text/terminfo-core.c +@@ -6,6 +6,10 @@ + # define _POSIX_VDISABLE 0 + #endif + ++#undef putc ++#define putc(x, y) (void) (x) ++#define fputc(x, y) (void) (x), 0 ++ + #define tput(s) tputs(s, 0, term_putchar) + inline static int term_putchar(int c) + { +diff --git a/src/irc/core/irc.c b/src/irc/core/irc.c +index 4dce3fc..25fbb34 100644 +--- a/src/irc/core/irc.c ++++ b/src/irc/core/irc.c +@@ -383,12 +383,13 @@ static void irc_parse_incoming(SERVER_REC *server) + signal_emit_id(signal_server_incoming, 2, server, str); + + if (server->connection_lost) +- server_disconnect(server); ++ exit(0); + + count++; + } + if (ret == -1) { + /* connection lost */ ++ exit(0); + server->connection_lost = TRUE; + server_disconnect(server); + } +diff --git a/src/lib-config/write.c b/src/lib-config/write.c +index 37e51f0..ee82726 100644 +--- a/src/lib-config/write.c ++++ b/src/lib-config/write.c +@@ -299,6 +299,8 @@ static int config_write_block(CONFIG_REC *rec, CONFIG_NODE *node, int list, int + + int config_write(CONFIG_REC *rec, const char *fname, int create_mode) + { ++ return 0; ++ + int ret; + int fd; + +diff --git a/src/perl/perl-core.c b/src/perl/perl-core.c +index 2c61df7..485fe25 100644 +--- a/src/perl/perl-core.c ++++ b/src/perl/perl-core.c +@@ -395,6 +395,7 @@ int perl_get_api_version(void) + + void perl_scripts_autorun(void) + { ++ return; + DIR *dirp; + struct dirent *dp; + struct stat statbuf; diff --git a/irssi-config.in b/irssi-config.in deleted file mode 100644 index cd529ed0..00000000 --- a/irssi-config.in +++ /dev/null @@ -1,9 +0,0 @@ -PROG_LIBS="@PROG_LIBS@" -COMMON_LIBS="@COMMON_LIBS@" - -PERL_LINK_LIBS="@PERL_LINK_LIBS@" -PERL_FE_LINK_LIBS="@PERL_FE_LINK_LIBS@" -PERL_LINK_FLAGS="@PERL_LINK_FLAGS@" - -CHAT_MODULES="@CHAT_MODULES@" -irc_MODULES="@irc_MODULES@" diff --git a/irssi-version.sh b/irssi-version.sh deleted file mode 100755 index 1fc6a558..00000000 --- a/irssi-version.sh +++ /dev/null @@ -1,28 +0,0 @@ -#!/bin/sh - -DATE=`GIT_DIR=$1/.git git log -1 --pretty=format:%ai HEAD` - -VERSION_DATE=`echo $DATE | cut -f 1 -d ' ' | tr -d -` -VERSION_TIME=`echo $DATE | cut -f 2 -d ' ' | awk -F: '{printf "%d", $1$2}'` - -if test -z "$VERSION_DATE"; then - exec>&2 - echo "**Error**: `basename "$0"` must be run in a git clone, cannot proceed." - exit 1 -fi - -echo "#define IRSSI_VERSION_DATE $VERSION_DATE" -echo "#define IRSSI_VERSION_TIME $VERSION_TIME" - -if echo "${VERSION}" | grep -q -- -head; then - # -head version, get extra details from git if we can - git_version=$(GIT_DIR=$1/.git git describe --dirty --long --always --tags) - if [ $? = 0 ]; then - new_version="$(echo "${VERSION}" | sed 's/-head//')" - # Because the git tag won't yet include the next release we modify the git - # describe output using the version defined from configure.ac. - version="${new_version}-$(echo "${git_version}" | sed 's/^.*-[0-9]\+-//')" - echo "#undef PACKAGE_VERSION" - echo "#define PACKAGE_VERSION \"${version}\"" - fi -fi diff --git a/irssi.conf b/irssi.conf index 0e486807..010520fd 100644 --- a/irssi.conf +++ b/irssi.conf @@ -1,10 +1,10 @@ servers = ( { address = "irc.dal.net"; chatnet = "DALnet"; port = "6667"; }, - { address = "ssl.efnet.org"; chatnet = "EFNet"; port = "9999"; use_tls = "yes"; }, + { address = "ssl.efnet.org"; chatnet = "EFNet"; port = "9999"; use_tls = "yes"; tls_verify = "no"; }, { address = "irc.esper.net"; chatnet = "EsperNet"; port = "6697"; use_tls = "yes"; tls_verify = "yes"; }, - { address = "chat.freenode.net"; chatnet = "Freenode"; port = "6697"; use_tls = "yes"; tls_verify = "yes"; }, + { address = "irc.libera.chat"; chatnet = "liberachat";port = "6697"; use_tls = "yes"; tls_verify = "yes"; }, { address = "irc.gamesurge.net"; chatnet = "GameSurge"; port = "6667"; }, - { address = "eu.irc6.net"; chatnet = "IRCnet"; port = "6667"; use_tls = "yes"; }, + { address = "ssl.ircnet.ovh"; chatnet = "IRCnet"; port = "6697"; use_tls = "yes"; tls_verify = "yes"; }, { address = "open.ircnet.net"; chatnet = "IRCnet"; port = "6667"; }, { address = "irc.ircsource.net"; chatnet = "IRCSource"; port = "6667"; }, { address = "irc.netfuze.net"; chatnet = "NetFuze"; port = "6667"; }, @@ -34,7 +34,7 @@ chatnets = { max_msgs = "4"; max_whois = "1"; }; - Freenode = { + liberachat = { type = "IRC"; max_kicks = "1"; max_msgs = "4"; @@ -95,8 +95,8 @@ chatnets = { channels = ( { name = "#lobby"; chatnet = "EsperNet"; autojoin = "No"; }, - { name = "#freenode"; chatnet = "Freenode"; autojoin = "No"; }, - { name = "#irssi"; chatnet = "Freenode"; autojoin = "No"; }, + { name = "#libera"; chatnet = "liberachat";autojoin = "No"; }, + { name = "#irssi"; chatnet = "liberachat";autojoin = "No"; }, { name = "#gamesurge"; chatnet = "GameSurge"; autojoin = "No"; }, { name = "#irssi"; chatnet = "IRCNet"; autojoin = "No"; }, { name = "#ircsource"; chatnet = "IRCSource"; autojoin = "No"; }, @@ -107,7 +107,7 @@ channels = ( aliases = { ATAG = "WINDOW SERVER"; - ADDALLCHANS = "SCRIPT EXEC foreach my \\$channel (Irssi::channels()) { Irssi::command(\"CHANNEL ADD -auto \\$channel->{name} \\$channel->{server}->{tag} \\$channel->{key}\")\\;}"; + ADDALLCHANS = "SCRIPT EXEC foreach my \\$channel (Irssi::channels()) { Irssi::command(\"CHANNEL ADD -auto \\$channel->{visible_name} \\$channel->{server}->{tag} \\$channel->{key}\")\\;}"; B = "BAN"; BACK = "AWAY"; BANS = "BAN"; @@ -115,7 +115,7 @@ aliases = { C = "CLEAR"; CALC = "EXEC - if command -v bc >/dev/null 2>&1\\; then printf '%s=' '$*'\\; echo '$*' | bc -l\\; else echo bc was not found\\; fi"; CHAT = "DCC CHAT"; - CUBES = "SCRIPT EXEC Irssi::active_win->print(\"%_bases\", MSGLEVEL_CLIENTCRAP) \\; Irssi::active_win->print( do { join '', map { \"%x0\\${_}0\\$_\" } '0'..'9','A'..'F' }, MSGLEVEL_NEVER | MSGLEVEL_CLIENTCRAP) \\; Irssi::active_win->print(\"%_cubes\", MSGLEVEL_CLIENTCRAP) \\; Irssi::active_win->print( do { my \\$y = \\$_*6 \\; join '', map { my \\$x = \\$_ \\; map { \"%x\\$x\\$_\\$x\\$_\" } @{['0'..'9','A'..'Z']}[\\$y .. \\$y+5] } 1..6 }, MSGLEVEL_NEVER | MSGLEVEL_CLIENTCRAP) for 0..5 \\; Irssi::active_win->print(\"%_grays\", MSGLEVEL_CLIENTCRAP) \\; Irssi::active_win->print( do { join '', map { \"%x7\\${_}7\\$_\" } 'A'..'X' }, MSGLEVEL_NEVER | MSGLEVEL_CLIENTCRAP) \\; Irssi::active_win->print(\"%_mIRC extended colours\", MSGLEVEL_CLIENTCRAP) \\; my \\$x \\; \\$x .= sprintf \"\00399,%02d%02d\",\\$_,\\$_ for 0..15 \\; Irssi::active_win->print(\\$x, MSGLEVEL_NEVER | MSGLEVEL_CLIENTCRAP) \\; for my \\$z (0..6) { my \\$x \\; \\$x .= sprintf \"\00399,%02d%02d\",\\$_,\\$_ for 16+(\\$z*12)..16+(\\$z*12)+11 \\; Irssi::active_win->print(\\$x, MSGLEVEL_NEVER | MSGLEVEL_CLIENTCRAP) }"; + CS = "QUOTE CS"; DATE = "TIME"; DEHIGHLIGHT = "DEHILIGHT"; DESCRIBE = "ACTION"; @@ -134,9 +134,12 @@ aliases = { LAST = "LASTLOG"; LEAVE = "PART"; M = "MSG"; + MS = "QUOTE MS"; MUB = "UNBAN *"; N = "NAMES"; NMSG = "^MSG"; + NS = "QUOTE NS"; + OS = "QUOTE OS"; P = "PART"; Q = "QUERY"; RESET = "SET -default"; @@ -144,8 +147,9 @@ aliases = { SAY = "MSG *"; SB = "SCROLLBACK"; SBAR = "STATUSBAR"; + SHELP = "QUOTE HELP"; SIGNOFF = "QUIT"; - SV = "MSG * Irssi $J ($V) - http://www.irssi.org"; + SV = "MSG * Irssi $J ($V) - https://irssi.org"; T = "TOPIC"; UB = "UNBAN"; UMODE = "MODE $N"; @@ -160,105 +164,6 @@ aliases = { WN = "WINDOW NEW HIDDEN"; WQUERY = "QUERY -window"; WW = "WHOWAS"; - 1 = "WINDOW GOTO 1"; - 2 = "WINDOW GOTO 2"; - 3 = "WINDOW GOTO 3"; - 4 = "WINDOW GOTO 4"; - 5 = "WINDOW GOTO 5"; - 6 = "WINDOW GOTO 6"; - 7 = "WINDOW GOTO 7"; - 8 = "WINDOW GOTO 8"; - 9 = "WINDOW GOTO 9"; - 10 = "WINDOW GOTO 10"; - 11 = "WINDOW GOTO 11"; - 12 = "WINDOW GOTO 12"; - 13 = "WINDOW GOTO 13"; - 14 = "WINDOW GOTO 14"; - 15 = "WINDOW GOTO 15"; - 16 = "WINDOW GOTO 16"; - 17 = "WINDOW GOTO 17"; - 18 = "WINDOW GOTO 18"; - 19 = "WINDOW GOTO 19"; - 20 = "WINDOW GOTO 20"; - 21 = "WINDOW GOTO 21"; - 22 = "WINDOW GOTO 22"; - 23 = "WINDOW GOTO 23"; - 24 = "WINDOW GOTO 24"; - 25 = "WINDOW GOTO 25"; - 26 = "WINDOW GOTO 26"; - 27 = "WINDOW GOTO 27"; - 28 = "WINDOW GOTO 28"; - 29 = "WINDOW GOTO 29"; - 30 = "WINDOW GOTO 30"; - 31 = "WINDOW GOTO 31"; - 32 = "WINDOW GOTO 32"; - 33 = "WINDOW GOTO 33"; - 34 = "WINDOW GOTO 34"; - 35 = "WINDOW GOTO 35"; - 36 = "WINDOW GOTO 36"; - 37 = "WINDOW GOTO 37"; - 38 = "WINDOW GOTO 38"; - 39 = "WINDOW GOTO 39"; - 40 = "WINDOW GOTO 40"; - 41 = "WINDOW GOTO 41"; - 42 = "WINDOW GOTO 42"; - 43 = "WINDOW GOTO 43"; - 44 = "WINDOW GOTO 44"; - 45 = "WINDOW GOTO 45"; - 46 = "WINDOW GOTO 46"; - 47 = "WINDOW GOTO 47"; - 48 = "WINDOW GOTO 48"; - 49 = "WINDOW GOTO 49"; - 50 = "WINDOW GOTO 50"; - 51 = "WINDOW GOTO 51"; - 52 = "WINDOW GOTO 52"; - 53 = "WINDOW GOTO 53"; - 54 = "WINDOW GOTO 54"; - 55 = "WINDOW GOTO 55"; - 56 = "WINDOW GOTO 56"; - 57 = "WINDOW GOTO 57"; - 58 = "WINDOW GOTO 58"; - 59 = "WINDOW GOTO 59"; - 60 = "WINDOW GOTO 60"; - 61 = "WINDOW GOTO 61"; - 62 = "WINDOW GOTO 62"; - 63 = "WINDOW GOTO 63"; - 64 = "WINDOW GOTO 64"; - 65 = "WINDOW GOTO 65"; - 66 = "WINDOW GOTO 66"; - 67 = "WINDOW GOTO 67"; - 68 = "WINDOW GOTO 68"; - 69 = "WINDOW GOTO 69"; - 70 = "WINDOW GOTO 70"; - 71 = "WINDOW GOTO 71"; - 72 = "WINDOW GOTO 72"; - 73 = "WINDOW GOTO 73"; - 74 = "WINDOW GOTO 74"; - 75 = "WINDOW GOTO 75"; - 76 = "WINDOW GOTO 76"; - 77 = "WINDOW GOTO 77"; - 78 = "WINDOW GOTO 78"; - 79 = "WINDOW GOTO 79"; - 80 = "WINDOW GOTO 80"; - 81 = "WINDOW GOTO 81"; - 82 = "WINDOW GOTO 82"; - 83 = "WINDOW GOTO 83"; - 84 = "WINDOW GOTO 84"; - 85 = "WINDOW GOTO 85"; - 86 = "WINDOW GOTO 86"; - 87 = "WINDOW GOTO 87"; - 88 = "WINDOW GOTO 88"; - 89 = "WINDOW GOTO 89"; - 90 = "WINDOW GOTO 90"; - 91 = "WINDOW GOTO 91"; - 92 = "WINDOW GOTO 92"; - 93 = "WINDOW GOTO 93"; - 94 = "WINDOW GOTO 94"; - 95 = "WINDOW GOTO 95"; - 96 = "WINDOW GOTO 96"; - 97 = "WINDOW GOTO 97"; - 98 = "WINDOW GOTO 98"; - 99 = "WINDOW GOTO 99"; }; statusbar = { @@ -281,7 +186,7 @@ statusbar = { prompt_empty = "{prompt $winname}"; topic = " $topic"; - topic_empty = " Irssi v$J - http://www.irssi.org"; + topic_empty = " Irssi v$J - https://irssi.org"; lag = "{sb Lag: $0-}"; act = "{sb Act: $0-}"; diff --git a/m4/glib-2.0.m4 b/m4/glib-2.0.m4 deleted file mode 100644 index 2c8760b7..00000000 --- a/m4/glib-2.0.m4 +++ /dev/null @@ -1,208 +0,0 @@ -# Configure paths for GLIB -# Owen Taylor 1997-2001 - -dnl AM_PATH_GLIB_2_0([MINIMUM-VERSION, [ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND [, MODULES]]]]) -dnl Test for GLIB, and define GLIB_CFLAGS and GLIB_LIBS, if gmodule, gobject or -dnl gthread is specified in MODULES, pass to pkg-config -dnl -AC_DEFUN([AM_PATH_GLIB_2_0], -[dnl -dnl Get the cflags and libraries from pkg-config -dnl -AC_ARG_ENABLE(glibtest, [ --disable-glibtest do not try to compile and run a test GLIB program], - , enable_glibtest=yes) - - pkg_config_args=glib-2.0 - for module in . $4 - do - case "$module" in - gmodule) - pkg_config_args="$pkg_config_args gmodule-2.0" - ;; - gmodule-no-export) - pkg_config_args="$pkg_config_args gmodule-no-export-2.0" - ;; - gobject) - pkg_config_args="$pkg_config_args gobject-2.0" - ;; - gthread) - pkg_config_args="$pkg_config_args gthread-2.0" - ;; - esac - done - - PKG_PROG_PKG_CONFIG([0.7]) - - no_glib="" - - if test "x$PKG_CONFIG" = x ; then - no_glib=yes - PKG_CONFIG=no - fi - - min_glib_version=ifelse([$1], ,2.0.0,$1) - AC_MSG_CHECKING(for GLIB - version >= $min_glib_version) - - if test x$PKG_CONFIG != xno ; then - ## don't try to run the test against uninstalled libtool libs - if $PKG_CONFIG --uninstalled $pkg_config_args; then - echo "Will use uninstalled version of GLib found in PKG_CONFIG_PATH" - enable_glibtest=no - fi - - if $PKG_CONFIG --atleast-version $min_glib_version $pkg_config_args; then - : - else - no_glib=yes - fi - fi - - if test x"$no_glib" = x ; then - GLIB_GENMARSHAL=`$PKG_CONFIG --variable=glib_genmarshal glib-2.0` - GOBJECT_QUERY=`$PKG_CONFIG --variable=gobject_query glib-2.0` - GLIB_MKENUMS=`$PKG_CONFIG --variable=glib_mkenums glib-2.0` - - GLIB_CFLAGS=`$PKG_CONFIG --cflags $pkg_config_args` - GLIB_LIBS=`$PKG_CONFIG --libs $pkg_config_args` - glib_config_major_version=`$PKG_CONFIG --modversion glib-2.0 | \ - sed 's/\([[0-9]]*\).\([[0-9]]*\).\([[0-9]]*\)/\1/'` - glib_config_minor_version=`$PKG_CONFIG --modversion glib-2.0 | \ - sed 's/\([[0-9]]*\).\([[0-9]]*\).\([[0-9]]*\)/\2/'` - glib_config_micro_version=`$PKG_CONFIG --modversion glib-2.0 | \ - sed 's/\([[0-9]]*\).\([[0-9]]*\).\([[0-9]]*\)/\3/'` - if test "x$enable_glibtest" = "xyes" ; then - ac_save_CFLAGS="$CFLAGS" - ac_save_LIBS="$LIBS" - CFLAGS="$CFLAGS $GLIB_CFLAGS" - LIBS="$GLIB_LIBS $LIBS" -dnl -dnl Now check if the installed GLIB is sufficiently new. (Also sanity -dnl checks the results of pkg-config to some extent) -dnl - rm -f conf.glibtest - AC_TRY_RUN([ -#include -#include -#include - -int -main () -{ - int major, minor, micro; - char *tmp_version; - - system ("touch conf.glibtest"); - - /* HP/UX 9 (%@#!) writes to sscanf strings */ - tmp_version = g_strdup("$min_glib_version"); - if (sscanf(tmp_version, "%d.%d.%d", &major, &minor, µ) != 3) { - printf("%s, bad version string\n", "$min_glib_version"); - exit(1); - } - - if ((glib_major_version != $glib_config_major_version) || - (glib_minor_version != $glib_config_minor_version) || - (glib_micro_version != $glib_config_micro_version)) - { - printf("\n*** 'pkg-config --modversion glib-2.0' returned %d.%d.%d, but GLIB (%d.%d.%d)\n", - $glib_config_major_version, $glib_config_minor_version, $glib_config_micro_version, - glib_major_version, glib_minor_version, glib_micro_version); - printf ("*** was found! If pkg-config was correct, then it is best\n"); - printf ("*** to remove the old version of GLib. You may also be able to fix the error\n"); - printf("*** by modifying your LD_LIBRARY_PATH enviroment variable, or by editing\n"); - printf("*** /etc/ld.so.conf. Make sure you have run ldconfig if that is\n"); - printf("*** required on your system.\n"); - printf("*** If pkg-config was wrong, set the environment variable PKG_CONFIG_PATH\n"); - printf("*** to point to the correct configuration files\n"); - } - else if ((glib_major_version != GLIB_MAJOR_VERSION) || - (glib_minor_version != GLIB_MINOR_VERSION) || - (glib_micro_version != GLIB_MICRO_VERSION)) - { - printf("*** GLIB header files (version %d.%d.%d) do not match\n", - GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION); - printf("*** library (version %d.%d.%d)\n", - glib_major_version, glib_minor_version, glib_micro_version); - } - else - { - if ((glib_major_version > major) || - ((glib_major_version == major) && (glib_minor_version > minor)) || - ((glib_major_version == major) && (glib_minor_version == minor) && (glib_micro_version >= micro))) - { - return 0; - } - else - { - printf("\n*** An old version of GLIB (%d.%d.%d) was found.\n", - glib_major_version, glib_minor_version, glib_micro_version); - printf("*** You need a version of GLIB newer than %d.%d.%d. The latest version of\n", - major, minor, micro); - printf("*** GLIB is always available from ftp://ftp.gtk.org.\n"); - printf("***\n"); - printf("*** If you have already installed a sufficiently new version, this error\n"); - printf("*** probably means that the wrong copy of the pkg-config shell script is\n"); - printf("*** being found. The easiest way to fix this is to remove the old version\n"); - printf("*** of GLIB, but you can also set the PKG_CONFIG environment to point to the\n"); - printf("*** correct copy of pkg-config. (In this case, you will have to\n"); - printf("*** modify your LD_LIBRARY_PATH enviroment variable, or edit /etc/ld.so.conf\n"); - printf("*** so that the correct libraries are found at run-time))\n"); - } - } - return 1; -} -],, no_glib=yes,[echo $ac_n "cross compiling; assumed OK... $ac_c"]) - CFLAGS="$ac_save_CFLAGS" - LIBS="$ac_save_LIBS" - fi - fi - if test "x$no_glib" = x ; then - AC_MSG_RESULT(yes (version $glib_config_major_version.$glib_config_minor_version.$glib_config_micro_version)) - ifelse([$2], , :, [$2]) - else - AC_MSG_RESULT(no) - if test "$PKG_CONFIG" = "no" ; then - echo "*** A new enough version of pkg-config was not found." - echo "*** See http://www.freedesktop.org/software/pkgconfig/" - else - if test -f conf.glibtest ; then - : - else - echo "*** Could not run GLIB test program, checking why..." - ac_save_CFLAGS="$CFLAGS" - ac_save_LIBS="$LIBS" - CFLAGS="$CFLAGS $GLIB_CFLAGS" - LIBS="$LIBS $GLIB_LIBS" - AC_TRY_LINK([ -#include -#include -], [ return ((glib_major_version) || (glib_minor_version) || (glib_micro_version)); ], - [ echo "*** The test program compiled, but did not run. This usually means" - echo "*** that the run-time linker is not finding GLIB or finding the wrong" - echo "*** version of GLIB. If it is not finding GLIB, you'll need to set your" - echo "*** LD_LIBRARY_PATH environment variable, or edit /etc/ld.so.conf to point" - echo "*** to the installed location Also, make sure you have run ldconfig if that" - echo "*** is required on your system" - echo "***" - echo "*** If you have an old version installed, it is best to remove it, although" - echo "*** you may also be able to get things to work by modifying LD_LIBRARY_PATH" ], - [ echo "*** The test program failed to compile or link. See the file config.log for the" - echo "*** exact error that occurred. This usually means GLIB is incorrectly installed."]) - CFLAGS="$ac_save_CFLAGS" - LIBS="$ac_save_LIBS" - fi - fi - GLIB_CFLAGS="" - GLIB_LIBS="" - GLIB_GENMARSHAL="" - GOBJECT_QUERY="" - GLIB_MKENUMS="" - ifelse([$3], , :, [$3]) - fi - AC_SUBST(GLIB_CFLAGS) - AC_SUBST(GLIB_LIBS) - AC_SUBST(GLIB_GENMARSHAL) - AC_SUBST(GOBJECT_QUERY) - AC_SUBST(GLIB_MKENUMS) - rm -f conf.glibtest -]) diff --git a/meson.build b/meson.build new file mode 100644 index 00000000..bb6d2829 --- /dev/null +++ b/meson.build @@ -0,0 +1,991 @@ +project( + 'irssi', + 'c', + version : '1.5-head', + meson_version : '>=0.53', + default_options : [ 'warning_level=1' ], +) + +############################ +############################ + +glib_internal_version = 'glib-2.74.7' # keep this in sync with subprojects/glib.wrap +glib_pcre2_internal_version = 'pcre2-10.40' +glib_libffi_internal_version = 'libffi' +cc = meson.get_compiler('c') +rootinc = include_directories('.') +dep = [ ] +textui_dep = [ ] +need_dl_cross_link = false +need_dl_cross_link_main = false +dl_cross_irssi_main = [ ] +# The Android environment requires that all modules are linked to each other. +# See https://github.com/android/ndk/issues/201 +if host_machine.system() == 'android' + need_dl_cross_link = true +elif host_machine.system() == 'cygwin' + need_dl_cross_link = true + need_dl_cross_link_main = true +endif + +includedir = get_option('includedir') +incdir = 'irssi' +moduledir = get_option('libdir') / incdir / 'modules' +helpdir = get_option('datadir') / incdir / 'help' +themedir = get_option('datadir') / incdir / 'themes' +scriptdir = get_option('datadir') / incdir / 'scripts' +docdir = get_option('docdir') != '' ? get_option('docdir') : (get_option('datadir') / 'doc' / incdir) + +want_textui = get_option('without-textui') != 'yes' +want_bot = get_option('with-bot') == 'yes' +want_fuzzer = get_option('with-fuzzer') == 'yes' +fuzzer_lib = get_option('with-fuzzer-lib') +fuzzer_link_language = get_option('fuzzer-link-language') +want_proxy = get_option('with-proxy') == 'yes' + +require_capsicum = get_option('with-capsicum') == 'yes' +want_capsicum = get_option('with-capsicum') != 'no' + +require_libutf8proc = get_option('disable-utf8proc') == 'no' +want_libutf8proc = get_option('disable-utf8proc') != 'yes' + +require_perl = get_option('with-perl') == 'yes' +want_perl = get_option('with-perl') != 'no' +with_perl_lib = get_option('with-perl-lib') + +require_otr = get_option('with-otr') == 'yes' +want_otr = get_option('with-otr') != 'no' + +want_glib_internal = get_option('install-glib') != 'no' +require_glib_internal = get_option('install-glib') == 'force' + +want_static_dependency = get_option('static-dependency') == 'yes' + +package_version = get_option('PACKAGE_VERSION') != '' ? get_option('PACKAGE_VERSION') : meson.project_version() + +fs = import('fs') +if fs.exists('config.status') or fs.exists('irssi-version.h') or fs.exists('default-config.h') or fs.exists('default-theme.h') or fs.exists('src/perl/irssi-core.pl.h') or fs.exists('src/perl/perl-signals-list.h') or fs.exists('irssi-config.h') + error('this tree has been configured with autotools, cannot proceed') +endif + +UNSET = '=INVALID=' +UNSET_ARR = [ UNSET ] + +chat_modules = [ 'irc' ] + +run_command( + 'mkdir', + meson.current_build_dir() / incdir, + check : false, +) +run_command( + 'ln', + '-s', meson.current_source_dir() / 'src', + meson.current_build_dir() / incdir, + check : false, +) +run_command( + 'ln', + '-s', meson.current_build_dir() / 'irssi-config.h', + meson.current_build_dir() / incdir, + check : false, +) +run_command( + 'ln', + '-s', meson.current_build_dir() / 'irssi-version.h', + meson.current_build_dir() / incdir, + check : false, +) + +def_moduledir = '-D' + 'MODULEDIR' + '="' + (get_option('prefix') / moduledir) + '"' +def_sysconfdir = '-D' + 'SYSCONFDIR' + '="' + (get_option('prefix') / get_option('sysconfdir')) + '"' +def_helpdir = '-D' + 'HELPDIR' + '="' + (get_option('prefix') / helpdir) + '"' +def_themesdir = '-D' + 'THEMESDIR' + '="' + (get_option('prefix') / themedir) + '"' +def_scriptdir = '-D' + 'SCRIPTDIR' + '="' + (get_option('prefix') / scriptdir) + '"' + +def_suppress_printf_fallback = '-D' + 'SUPPRESS_PRINTF_FALLBACK' + +module_suffix = [ ] +perl_module_suffix = [ ] +# Meson uses the wrong module extensions on Mac. +# https://gitlab.gnome.org/GNOME/glib/issues/520 +if [ 'darwin', 'ios' ].contains(host_machine.system()) + module_suffix = 'so' + perl_module_suffix = 'bundle' +endif + +############## +# Help files # +############## + +build_perl = find_program( + 'perl', + native : true, +) +if meson.is_cross_build() + cross_perl = find_program('perl') +else + cross_perl = build_perl +endif +run_command( + build_perl, + files('utils/syntax.pl'), + check : true, +) + +################### +# irssi-version.h # +################### + +env = find_program('env') +irssi_version_sh = find_program('utils/irssi-version.sh') +irssi_version_h = custom_target( + 'irssi-version.h', + build_by_default : true, + build_always_stale : true, + capture : true, + command : [ env, 'VERSION=' + meson.project_version(), irssi_version_sh, meson.current_source_dir() ], + output : 'irssi-version.h', + install : true, + install_dir : includedir / incdir, +) + +#################### +# default-config.h # +#################### + +file2header = find_program('utils/file2header.sh') +default_config_h = custom_target( + 'default-config.h', + input : files('irssi.conf'), + output : 'default-config.h', + capture : true, + command : [ file2header, '@INPUT@', 'default_config' ], +) + +################### +# default-theme.h # +################### + +default_theme_h = custom_target( + 'default-theme.h', + input : files('themes/default.theme'), + output : 'default-theme.h', + capture : true, + command : [ file2header, '@INPUT@', 'default_theme' ], +) + +################ +# Dependencies # +################ + +#### inet_addr #### +inet_addr_found = false +foreach inet_addr_provider : [ '', 'nsl' ] + prov_lib = [ ] + if inet_addr_provider != '' + prov_lib += cc.find_library( + inet_addr_provider, + required : false, + ) + endif + if (prov_lib.length() == 0 or prov_lib[0].found()) and cc.has_function( + 'inet_addr', + dependencies : prov_lib, + ) + dep += prov_lib + inet_addr_found = true + break + endif +endforeach +if not inet_addr_found + error('inet_addr not found') +endif + +#### socket #### +socket_found = false +foreach socket_provider : [ '', 'socket', 'network' ] + prov_lib = [ ] + if socket_provider != '' + prov_lib += cc.find_library( + socket_provider, + required : false, + ) + endif + if (prov_lib.length() == 0 or prov_lib[0].found()) and cc.has_function( + 'socket', + dependencies : prov_lib, + ) + dep += prov_lib + socket_found = true + break + endif +endforeach +if not socket_found + error('socket not found') +endif + +built_src = [ ] +glib_internal = false +message('*** If you don\'t have GLib, you can run meson ... -Dinstall-glib=yes') +message('*** to download and build it automatically') +message('*** Or alternatively install your distribution\'s package') +message('*** On Debian: sudo apt-get install libglib2.0-dev') +message('*** On Redhat: dnf install glib2-devel') +if not require_glib_internal + glib_dep = dependency( + 'glib-2.0', + version : '>=2.32', + required : not want_glib_internal, + static : want_static_dependency, + include_type : 'system', + ) +else + glib_dep = dependency( + '', + required : false, + ) +endif +if not glib_dep.found() + glib_internal = true + meson_cmd = find_program('meson') + ninja = find_program('ninja') + + glib_internal_download_t = custom_target( + 'glib-internal-download', + command : [ meson_cmd, 'subprojects', 'download', 'glib', '--sourcedir', meson.current_source_dir() ], + console : true, + output : [ 'glib-internal-download' ], + ) + + glib_internal_dependencies = [ + dependency('threads'), + ] + glib_internal_configure_args = [ ] + + glib_internal_usr_local = false + if not cc.has_function('iconv_open') + prov_lib = cc.find_library( + 'iconv', + required : false, + ) + if not prov_lib.found() + prov_lib = cc.find_library( + 'iconv', + dirs : '/usr/local/lib', + ) + glib_internal_usr_local = true + endif + glib_internal_dependencies += prov_lib + endif + + if not cc.has_function('ngettext') + prov_lib = cc.find_library( + 'intl', + required : false, + ) + if not prov_lib.found() + prov_lib = cc.find_library( + 'intl', + dirs : '/usr/local/lib', + ) + glib_internal_usr_local = true + endif + glib_internal_dependencies += prov_lib + endif + + if glib_internal_usr_local + glib_internal_configure_args += [ '-Dc_args=-I/usr/local/include', '-Dc_link_args=-L/usr/local/lib' ] + endif + + if not cc.has_function('getxattr') or not cc.has_header('sys/xattr.h') + if cc.has_header_symbol('attr/xattr.h', 'getxattr') + prov_lib = cc.find_library( + 'xattr', + required : false, + ) + else + prov_lib = dependency( + '', + required : false, + ) + endif + if prov_lib.found() + glib_internal_dependencies += prov_lib + else + glib_internal_configure_args += '-Dxattr=false' + endif + endif + + glib_internal_configure_t = custom_target( + 'glib-internal-configure', + command : [ + meson_cmd, + 'setup', + '--prefix=/irssi-glib-internal', + '--buildtype=' + get_option('buildtype'), + '-Dlibmount=disabled', + '-Dselinux=disabled', + '-Ddefault_library=static', + '-Dforce_fallback_for=pcre2,libffi', + glib_internal_configure_args, + (meson.current_build_dir() / 'build-subprojects' / 'glib'), + (meson.current_source_dir() / 'subprojects' / glib_internal_version), + ], + console : true, + output : [ 'glib-internal-configure' ], + depends : glib_internal_download_t, + ) + glib_internal_build_t = custom_target( + 'glib-internal-build', + command : [ + ninja, + '-C', meson.current_build_dir() / 'build-subprojects' / 'glib', + 'subprojects' / glib_libffi_internal_version / 'src' / 'libffi.a', + 'subprojects' / glib_pcre2_internal_version / 'libpcre2-8.a', + 'glib' / 'libglib-2.0.a', + 'gmodule' / 'libgmodule-2.0.a', + 'gobject' / 'libgobject-2.0.a', + 'gio' / 'libgio-2.0.a', + ], + console : true, + output : [ 'glib-internal-build' ], + depends : glib_internal_configure_t, + ) + glib_dep = declare_dependency( + dependencies : glib_internal_dependencies, + sources : glib_internal_build_t, + compile_args : [ + '-isystem' + (meson.current_source_dir() / 'subprojects' / glib_internal_version / 'glib'), + '-isystem' + (meson.current_source_dir() / 'subprojects' / glib_internal_version), + '-isystem' + (meson.current_build_dir() / 'build-subprojects' / 'glib' / 'glib'), + ], + link_args : [ + meson.current_build_dir() / 'build-subprojects' / 'glib' / 'subprojects' / glib_pcre2_internal_version / 'libpcre2-8.a', + meson.current_build_dir() / 'build-subprojects' / 'glib' / 'glib' / 'libglib-2.0.a', + ], + ) + built_src += glib_internal_build_t + libdl_dep = [ ] + prov_lib = cc.find_library( + 'dl', + required : false, + ) + if prov_lib.found() and cc.has_function( + 'dlopen', + dependencies : prov_lib, + ) + libdl_dep += prov_lib + endif + gmodule_dep = declare_dependency( + sources : glib_internal_build_t, + dependencies : libdl_dep, + compile_args : [ + '-isystem' + (meson.current_source_dir() / 'subprojects' / glib_internal_version / 'gmodule'), + ], + link_args : [ meson.current_build_dir() / 'build-subprojects' / 'glib' / 'gmodule' / 'libgmodule-2.0.a' ], + ) + gobject_dep = declare_dependency( + sources : glib_internal_build_t, + compile_args : [ + '-isystem' + (meson.current_build_dir() / 'build-subprojects' / 'glib'), + ], + link_args : [ + meson.current_build_dir() / 'build-subprojects' / 'glib' / 'subprojects' / glib_libffi_internal_version / 'src' / 'libffi.a', + meson.current_build_dir() / 'build-subprojects' / 'glib' / 'gobject' / 'libgobject-2.0.a', + ], + ) + gio_dep = declare_dependency( + sources : glib_internal_build_t, + dependencies : cc.find_library('z'), + compile_args : [ + '-isystem' + (meson.current_source_dir() / 'subprojects' / glib_internal_version / 'gio'), + '-isystem' + (meson.current_build_dir() / 'build-subprojects' / 'glib'), + ], + link_args : [ meson.current_build_dir() / 'build-subprojects' / 'glib' / 'gio' / 'libgio-2.0.a' ], + ) +else + gmodule_dep = dependency( + 'gmodule-2.0', + static : want_static_dependency, + include_type : 'system', + ) + gobject_dep = dependency( + 'gobject-2.0', + static : want_static_dependency, + include_type : 'system', + ) + gio_dep = dependency( + 'gio-2.0', + static : want_static_dependency, + include_type : 'system', + ) +endif +dep += glib_dep +dep += gmodule_dep +dep += gobject_dep +dep += gio_dep + +if glib_internal and want_static_dependency and want_fuzzer + openssl_proj = subproject( + 'openssl', + default_options : [ 'default_library=static', 'asm=disabled' ], + ) + openssl_dep = openssl_proj.get_variable('openssl_dep') +else + openssl_dep = dependency( + 'openssl', + static : want_static_dependency, + include_type : 'system', + ) +endif +dep += openssl_dep + +############ +# utf8proc # +############ + +have_libutf8proc = false +libutf8proc = [ ] +if want_libutf8proc + libutf8proc = cc.find_library( + 'utf8proc', + required : require_libutf8proc, + ) + have_libutf8proc = cc.has_function( + 'utf8proc_version', + dependencies : libutf8proc, + ) + if have_libutf8proc + dep += libutf8proc + endif +endif + +############################ +############################ + +############ +# terminfo # +############ + +if want_textui + setupterm_found = false + foreach setupterm_provider : [ 'tinfo', 'ncursesw', 'ncurses', 'terminfo' ] + prov_lib = cc.find_library( + setupterm_provider, + required : false, + ) + if prov_lib.found() and cc.has_function( + 'setupterm', + dependencies : prov_lib, + ) + textui_dep += prov_lib + setupterm_found = true + break + endif + endforeach + if not setupterm_found + error('Terminfo not found') + endif +endif + +######## +# perl # +######## + +have_perl = false +if want_perl + perl_cflags = [ ] + perl_ldflags = [ ] + perl_rpath_flags = [ ] + perl_rpath = '' + + #### ccopts #### + perl_ccopts = meson.get_cross_property('perl_ccopts', UNSET_ARR) + if perl_ccopts == UNSET_ARR + res = run_command( + cross_perl, + '-MExtUtils::Embed', + '-e', 'ccopts', + check : true, + ) + perl_ccopts = res.stdout().strip().split() + endif + foreach fl : perl_ccopts + if fl.startswith('-D') or fl.startswith('-U') or fl.startswith('-I') or fl.startswith('-i') or fl.startswith('-f') or fl.startswith('-m') + if fl.startswith('-I') + fl = '-isystem' + fl.split('-I')[1] + endif + perl_cflags += fl + endif + endforeach + + perl_cflags += cc.get_supported_arguments('-fPIC') + + #### ldopts #### + perl_ldopts = meson.get_cross_property('perl_ldopts', UNSET_ARR) + if perl_ldopts == UNSET_ARR + res = run_command( + cross_perl, + '-MExtUtils::Embed', + '-e', 'ldopts', + check : true, + ) + perl_ldopts = res.stdout().strip().split() + endif + skip_libs = [ '-ldb', '-ldbm', '-lndbm', '-lgdbm', '-lc', '-lposix', '-rdynamic' ] + foreach fl : perl_ldopts + if not fl.startswith('-A') and not skip_libs.contains(fl) + if fl.startswith('-Wl,-rpath,') + perl_rpath = fl.split(',')[2] + perl_rpath_flags += fl + else + perl_ldflags += fl + endif + endif + endforeach + + perl_version = meson.get_cross_property('perl_version', UNSET) + if perl_version == UNSET + perl_version = run_command( + cross_perl, + '-V::version:', + check : true, + ).stdout().split('\'')[1] + endif + + # disable clang warning + if perl_version.version_compare('<5.35.2') + perl_cflags += cc.get_supported_arguments('-Wno-compound-token-split-by-macro') + endif + perl_dep = declare_dependency( + compile_args : perl_cflags, + link_args : perl_ldflags, + version : perl_version, + ) + + #### + if not cc.links( + ''' +#include +#include +int main() +{ + perl_alloc(); + return 0; +} +''', + args : perl_cflags + perl_ldflags + perl_rpath_flags, + name : 'working Perl support', + ) + if require_perl + error('error linking with perl libraries') + else + warning('error linking with perl libraries') + endif + else + xsubpp_file_c = meson.get_cross_property('perl_xsubpp', UNSET) + if xsubpp_file_c == UNSET + xsubpp_file_c = run_command( + build_perl, + '-MExtUtils::ParseXS', + '-e($r = $INC{"ExtUtils/ParseXS.pm"}) =~ s{ParseXS\\.pm$}{xsubpp}; print $r', + check : true, + ).stdout() + endif + xsubpp = generator( + build_perl, + output : '@BASENAME@.c', + capture : true, + arguments : [ xsubpp_file_c, '@EXTRA_ARGS@', '@INPUT@' ], + ) + xsubpp_file = files(xsubpp_file_c) + + if with_perl_lib == 'module' + perl_install_base = run_command( + build_perl, + '-MText::ParseWords=shellwords', + '-e', 'grep { s/^INSTALL_BASE=// && print && exit } shellwords $ENV{PERL_MM_OPT}', + check : true, + ).stdout() + if perl_install_base == '' + with_perl_lib = '' + endif + endif + if with_perl_lib == '' + if get_option('prefix') in [ '/usr/local', 'C:/' ] + with_perl_lib = 'site' + elif get_option('prefix') in [ '/usr' ] + with_perl_lib = 'vendor' + endif + endif + perlmoddir = '' + if with_perl_lib in [ 'site', 'vendor', 'module' ] + set_perl_use_lib = false + perl_library_dir = with_perl_lib + ' default' + if with_perl_lib in [ 'site', 'vendor' ] + perlmoddir = meson.get_cross_property('perl_install' + with_perl_lib + 'arch', UNSET) + if perlmoddir == UNSET + perlmoddir = run_command( + cross_perl, + '-V::install' + with_perl_lib + 'arch:', + check : true, + ).stdout().split('\'')[1] + endif + elif with_perl_lib == 'module' + perl_archname = meson.get_cross_property('perl_archname', UNSET) + if perl_archname == UNSET + perl_archname = run_command( + cross_perl, + '-V::archname:', + check : true, + ).stdout().split('\'')[1] + endif + perlmoddir = perl_install_base / 'lib' / 'perl5' / perl_archname + endif + elif with_perl_lib == '' + set_perl_use_lib = true + perl_library_dir = 'in prefix' + perlmoddir = get_option('libdir') / incdir / 'perl' + elif with_perl_lib.startswith('/') + set_perl_use_lib = true + perl_library_dir = 'custom' + perlmoddir = with_perl_lib + endif + if perlmoddir == '' + error('Unrecognised with-perl-lib value: ' + with_perl_lib) + endif + + perl_use_lib = get_option('prefix') / perlmoddir + if set_perl_use_lib + perl_inc = meson.get_cross_property('perl_inc', UNSET_ARR) + if perl_inc == UNSET_ARR + set_perl_use_lib = run_command( + cross_perl, + '-e', 'exit ! grep $_ eq $ARGV[0], grep /^\\//, @INC', + perl_use_lib, + check : false, + ).returncode() != 0 + else + set_perl_use_lib = not perl_inc.contains(perl_use_lib) + endif + if not set_perl_use_lib + perl_library_dir += ' - other path in @INC' + else + perl_library_dir += ' - prepends to @INC with /set perl_use_lib' + endif + endif + def_perl_use_lib = '-D' + 'PERL_USE_LIB' + '="' + if set_perl_use_lib + def_perl_use_lib += perl_use_lib + endif + def_perl_use_lib += '"' + + have_perl = true + endif +endif + +####### +# OTR # +####### + +have_otr = false +if want_otr + libgcrypt = dependency( + 'libgcrypt', + version : '>=1.2.0', + required : require_otr, + static : want_static_dependency, + include_type : 'system', + ) + libotr = dependency( + 'libotr', + version : '>=4.1.0', + required : require_otr, + static : want_static_dependency, + include_type : 'system', + ) + if libgcrypt.found() and libotr.found() + dep += libgcrypt + dep += libotr + have_otr = true + endif +endif + +############ +# capsicum # +############ + +have_capsicum = false +if want_capsicum + if cc.has_function( + 'cap_enter', + dependencies : cc.find_library('c'), + ) + libnv = cc.find_library( + 'nv', + required : require_capsicum, + ) + nvlist_create_found = libnv.found() and cc.has_function( + 'nvlist_create', + dependencies : libnv, + prefix : '#include ', + ) + if nvlist_create_found + dep += libnv + have_capsicum = true + else + if require_capsicum + error('nvlist_create not found') + endif + endif + else + if require_capsicum + error('cap_enter not found') + endif + endif +endif + +# dependency helper sets +dep_cflagsonly = [ ] +foreach d : dep + dep_cflagsonly += d.partial_dependency( + includes : true, + compile_args : true, + ) +endforeach +dl_cross_dep = [ ] +if need_dl_cross_link + dl_cross_dep = dep +endif + +################## +# irssi-config.h # +################## + +conf = configuration_data() + +conf.set( + 'HAVE_CAPSICUM', + have_capsicum, + description : 'Build with Capsicum support', +) +conf.set('HAVE_GMODULE', true) +conf.set('TERM_TRUECOLOR', true) +conf.set('USE_GREGEX', true) +conf.set10( + '_DARWIN_USE_64_BIT_INODE', + true, + description : 'Enable large inode numbers on Mac OS X 10.5.', +) +conf.set_quoted('FHS_PREFIX', get_option('fhs-prefix')) + +headers = [ + 'sys/ioctl.h', + 'sys/resource.h', + 'sys/time.h', + 'sys/utsname.h', + 'dirent.h', + 'term.h', + 'unistd.h', +] +foreach h : headers + if cc.has_header(h) + conf.set( + 'HAVE_' + h.underscorify().to_upper(), + 1, + description : 'Define to 1 if you have the <' + h + '> header file.', + ) + endif +endforeach + +if want_textui and conf.get('HAVE_TERM_H', 0) == 1 + if cc.links( + ''' +#include +#include +int main (void) { + return tputs("x", 1, putchar); +} +''', + args : '-pedantic-errors', + dependencies : textui_dep, + name : 'Curses working', + ) + # ok + else + has_curses_h = cc.has_header('curses.h') + if has_curses_h and cc.links( + ''' +#include +#include +int main (void) { + return tputs("x", 1, putchar); +} +''', + args : '-pedantic-errors', + dependencies : textui_dep, + name : 'Curses working with curses.h', + ) + conf.set( + 'NEED_CURSES_H', + 1, + description : 'tputs needs curses.h', + ) + else + if has_curses_h and cc.links( + ''' +#include +#include +int char_putchar (char c) { + return putchar(c); +} +int main (void) { + return tputs("x", 1, char_putchar); +} +''', + args : '-pedantic-errors', + dependencies : textui_dep, + name : 'Curses with tputs third argument arg char', + ) + conf.set( + 'NEED_CURSES_H', + 1, + description : 'tputs needs curses.h', + ) + conf.set( + 'TPUTS_SVR4', + 1, + description : 'third argument of tputs has the type int (*)(char)', + ) + else + error('could not link terminfo') + endif + endif + endif +endif + +conf.set('HAVE_LIBUTF8PROC', have_libutf8proc) +conf.set_quoted('PACKAGE_VERSION', package_version) +conf.set_quoted('PACKAGE_TARNAME', meson.project_name()) + +configure_file( + output : 'irssi-config.h', + configuration : conf, + install_dir : includedir / incdir, +) + +########## +# CFLAGS # +########## + +#### warnings #### +add_project_arguments( + cc.get_supported_arguments('-Werror=declaration-after-statement'), + language : 'c', +) + +#### personality #### +add_project_arguments( + cc.get_supported_arguments('-fno-strict-aliasing'), + language : 'c', +) +if get_option('buildtype').contains('debug') + add_project_arguments( + cc.get_supported_arguments('-fno-omit-frame-pointer'), + language : 'c', + ) +endif + +if want_fuzzer + if fuzzer_lib.startswith('-fsanitize=fuzzer') + if not cc.has_argument('-fsanitize=fuzzer-no-link') + error('compiler does not support -fsanitize=fuzzer-no-link, try clang?') + endif + add_project_arguments( + '-fsanitize=fuzzer-no-link', + language : 'c', + ) + endif + if fuzzer_link_language != 'c' + add_languages(fuzzer_link_language) + endif +endif + +############## +# irssi-1.pc # +############## + +pc = import('pkgconfig') +pc_requires = [ ] +if not glib_internal + pc_requires += glib_dep +endif +signalsfile = docdir / 'signals.txt' +if signalsfile.startswith('/') + signalsfile = signalsfile.split(get_option('prefix')) + if signalsfile[0] == '' + signalsfile = '${prefix}' + signalsfile[1] + else + signalsfile = signalsfile[0] + endif +else + signalsfile = '${prefix}' / signalsfile +endif +pc.generate( + filebase : 'irssi-1', + name : 'Irssi', + description : 'Irssi chat client', + version : package_version, + requires : pc_requires, + variables : [ 'irssimoduledir=${libdir}' / incdir / 'modules', 'signalsfile=' + signalsfile ], +) + +########### +# irssi.1 # +########### + +install_man('docs/irssi.1') + +########### +# subdirs # +########### + +subdir('src') +subdir('tests') +subdir('docs') +subdir('scripts') +subdir('themes') +# subdir('utils') + +############################ +############################ + +message('*** Irssi configured ***') +message('') +message('Building text frontend ........... : ' + want_textui.to_string('yes', 'no')) +message('Building irssi bot ............... : ' + want_bot.to_string('yes', 'no')) +message('Building irssi proxy ............. : ' + want_proxy.to_string('yes', 'no')) +if want_perl and not have_perl + message('Building with Perl support ....... : NO!') + message(' - Try: sudo apt-get install libperl-dev') + message(' - Or: dnf install perl-devel') +else + message('Building with Perl support ....... : ' + have_perl.to_string('yes', 'no')) +endif +if have_perl + message('Perl library directory ........... : ' + perl_use_lib) + message(' ' + perl_library_dir) +endif +message('Install prefix ................... : ' + get_option('prefix')) +message('') +message('Building with Capsicum ........... : ' + have_capsicum.to_string('yes', 'no')) +message('Building with utf8proc ........... : ' + have_libutf8proc.to_string('yes', 'no')) +message('Building with OTR support ........ : ' + have_otr.to_string('yes', 'no')) +message('') +message('If there are any problems, read the INSTALL file.') +message('Now type ninja -C ' + meson.current_build_dir() + ' to build Irssi') +message('') + +############################ +############################ diff --git a/meson_options.txt b/meson_options.txt new file mode 100644 index 00000000..a5b4ffbb --- /dev/null +++ b/meson_options.txt @@ -0,0 +1,16 @@ +option('without-textui', type : 'combo', description : 'Build without text frontend', choices : ['no', 'yes']) +option('with-bot', type : 'combo', description : 'Build irssi-bot', choices : ['no', 'yes']) +option('with-fuzzer', type : 'combo', description : 'Build irssi-fuzzer', choices : ['no', 'yes']) +option('with-fuzzer-lib', type : 'string', description : 'Specify path to fuzzer library', value : '-fsanitize=fuzzer') +option('fuzzer-link-language', type : 'string', description : 'The linker to use for the fuzz targets [c, cpp]', value : 'c') +option('with-proxy', type : 'combo', description : 'Build irssi-proxy', choices : ['no', 'yes']) +option('with-perl-lib', type : 'string', description : 'Specify where to install the Perl libraries for Irssi') +option('with-perl', type : 'combo', description : 'Build with Perl support', choices : ['auto', 'yes', 'no']) +option('with-otr', type : 'combo', description : 'Build with OTR support', choices : ['auto', 'yes', 'no']) +option('disable-utf8proc', type : 'combo', description : 'Build without Julia\'s utf8proc', choices : ['auto', 'yes', 'no']) +option('with-capsicum', type : 'combo', description : 'Build with Capsicum support', choices : ['auto', 'yes', 'no']) +option('static-dependency', type : 'combo', description : 'Request static dependencies', choices : ['no', 'yes']) +option('install-glib', type : 'combo', description : 'Download and install GLib for you', choices : ['no', 'yes', 'force']) +option('docdir', type : 'string', description : 'Documentation directory') +option('fhs-prefix', type : 'string', description : 'System prefix for Termux') +option('PACKAGE_VERSION', type : 'string', description : 'Override PACKAGE_VERSION in tarballs') diff --git a/scripts/Makefile.am b/scripts/Makefile.am deleted file mode 100644 index cd795153..00000000 --- a/scripts/Makefile.am +++ /dev/null @@ -1,17 +0,0 @@ -SUBDIRS = examples - -scriptdir = $(datadir)/irssi/scripts - -script_DATA = \ - autoop.pl \ - autorejoin.pl \ - buf.pl \ - dns.pl \ - kills.pl \ - mail.pl \ - mlock.pl \ - quitmsg.pl \ - scriptassist.pl \ - usercount.pl - -EXTRA_DIST = $(script_DATA) diff --git a/scripts/autoop.pl b/scripts/autoop.pl index b72def15..ce37e705 100644 --- a/scripts/autoop.pl +++ b/scripts/autoop.pl @@ -5,7 +5,7 @@ use Irssi; use strict; use vars qw($VERSION %IRSSI); -$VERSION = "1.10"; +$VERSION = "1.11"; %IRSSI = ( authors => 'Timo Sirainen & Jostein Kjønigsen', name => 'autoop', @@ -98,10 +98,11 @@ sub load_autoops { %opnicks = (); open(CONF, "<", "$file") or return; while (my $line = ) { - if ($line !=~ /^\s*$/) { - cmd_autoop($line); - $count++; - } + chomp($line); + if ($line !~ /^\s*$/) { + cmd_autoop($line); + $count++; + } } close(CONF); diff --git a/scripts/autorejoin.pl b/scripts/autorejoin.pl index 42c97da7..e5be21b2 100644 --- a/scripts/autorejoin.pl +++ b/scripts/autorejoin.pl @@ -1,6 +1,9 @@ -# automatically rejoin to channel after kick +# automatically rejoin to channel after kicked # delayed rejoin: Lam 28.10.2001 (lam@lac.pl) +# /SET autorejoin_channels #channel1 #channel2 ... +# /SET autorejoin_delay 5 + # NOTE: I personally don't like this feature, in most channels I'm in it # will just result as ban. You've probably misunderstood the idea of /KICK # if you kick/get kicked all the time "just for fun" ... @@ -9,31 +12,22 @@ use Irssi; use Irssi::Irc; use strict; use vars qw($VERSION %IRSSI); -$VERSION = "1.0.0"; +$VERSION = "1.1.0"; %IRSSI = ( authors => "Timo 'cras' Sirainen, Leszek Matok", contact => "lam\@lac.pl", name => "autorejoin", - description => "Automatically rejoin to channel after being kick, after a (short) user-defined delay", + description => "Automatically rejoin to channel after being kicked, after a (short) user-defined delay", license => "GPLv2", changed => "10.3.2002 14:00" ); - -# How many seconds to wait before the rejoin? -# TODO: make this a /setting -my $delay = 5; - -my @tags; -my $acttag = 0; - sub rejoin { my ( $data ) = @_; - my ( $tag, $servtag, $channel, $pass ) = split( / +/, $data ); + my ( $servtag, $channel, $pass ) = @{$data}; my $server = Irssi::server_find_tag( $servtag ); $server->send_raw( "JOIN $channel $pass" ) if ( $server ); - Irssi::timeout_remove( $tags[$tag] ); } sub event_rejoin_kick { @@ -48,10 +42,31 @@ sub event_rejoin_kick { my $rejoinchan = $chanrec->{ name } if ( $chanrec ); my $servtag = $server->{ tag }; - Irssi::print "Rejoining $rejoinchan in $delay seconds."; - $tags[$acttag] = Irssi::timeout_add( $delay * 1000, "rejoin", "$acttag $servtag $rejoinchan $password" ); - $acttag++; - $acttag = 0 if ( $acttag > 60 ); + # check if we want to autorejoin this channel + my $chans = Irssi::settings_get_str( 'autorejoin_channels' ); + + if ( $chans ) { + my $found = 0; + foreach my $chan ( split( /[ ,]/, $chans ) ) { + if ( lc( $chan ) eq lc( $channel ) ) { + $found = 1; + last; + } + } + return unless $found; + } + + my @args = ($servtag, $rejoinchan, $password); + my $delay = Irssi::settings_get_int( "autorejoin_delay" ); + + if ($delay) { + Irssi::print "Rejoining $rejoinchan in $delay seconds."; + Irssi::timeout_add_once( $delay * 1000, "rejoin", \@args ); + } else { + rejoin( \@args ); + } } +Irssi::settings_add_int('misc', 'autorejoin_delay', 5); +Irssi::settings_add_str('misc', 'autorejoin_channels', ''); Irssi::signal_add( 'event kick', 'event_rejoin_kick' ); diff --git a/scripts/buf.pl b/scripts/buf.pl index 6d907f12..0b37e9de 100644 --- a/scripts/buf.pl +++ b/scripts/buf.pl @@ -1,22 +1,24 @@ use strict; use vars qw($VERSION %IRSSI); +use Storable; +use 5.014000; use Irssi qw(command signal_add signal_add_first active_win settings_get_str settings_get_bool channels windows - settings_add_str settings_add_bool get_irssi_dir - window_find_refnum signal_stop); -$VERSION = '2.20'; + settings_add_str settings_add_bool get_irssi_dir + window_find_refnum signal_stop); +$VERSION = '3.00'; %IRSSI = ( - authors => 'Juerd', - contact => 'juerd@juerd.nl', - name => 'Scroll buffer restorer', - description => 'Saves the buffer for /upgrade, so that no information is lost', - license => 'Public Domain', - url => 'http://juerd.nl/irssi/', - changed => 'Thu Sep 22 01:37 CEST 2016', - changes => 'Fixed file permissions (leaked everything via filesystem)', - note1 => 'This script HAS TO BE in your scripts/autorun!', - note2 => 'Perl support must be static or in startup', + authors => 'Juerd', + contact => 'juerd@juerd.nl', + name => 'Scroll buffer restorer', + description => 'Saves the buffer for /upgrade, so that no information is lost', + license => 'Public Domain', + url => 'http://juerd.nl/irssi/', + changed => 'Thu Mar 29 10:00 CEST 2018', + changes => 'Fixed file permissions (leaked everything via filesystem), rewritten to use Storable and print to correct levels', + note1 => 'This script HAS TO BE in your scripts/autorun!', + note2 => 'Perl support must be static or in startup', ); # Q: How can I get a very smooth and clean upgrade? @@ -40,30 +42,28 @@ my %suppress; sub _filename { sprintf '%s/scrollbuffer', get_irssi_dir } sub upgrade { - my $fn = _filename; - my $old_umask = umask 0077; - open my $fh, q{>}, $fn or die "open $fn: $!"; - umask $old_umask; - - print $fh join("\0", map $_->{server}->{address} . $_->{name}, channels), "\n"; + my $out = { suppress => [ map $_->{server}->{address} . $_->{name}, channels ] }; for my $window (windows) { - next unless defined $window; - next if $window->{name} eq 'status'; - my $view = $window->view; - my $line = $view->get_lines; - my $lines = 0; - my $buf = ''; - if (defined $line){ - { - $buf .= $line->get_text(1) . "\n"; - $line = $line->next; - $lines++; - redo if defined $line; - } - } - printf $fh "%s:%s\n%s", $window->{refnum}, $lines, $buf; + next unless defined $window; + next if $window->{name} eq 'status'; + my $view = $window->view; + my $line = $view->get_lines; + my $lines = 0; + my $buf = ''; + my $output; + if (defined $line) { + { + push @$output, { level => $line->{info}{level}, data => $line->get_text(1) }; + $line = $line->next; + redo if defined $line; + } + } + push @{$out->{windows}}, { refnum => $window->{refnum}, lines => $output }; } - close $fh; + my $old_umask = umask 0077; + my $fn = _filename; + store($out, $fn) or die "Could not store data to $fn"; + umask $old_umask; unlink sprintf("%s/sessionconfig", get_irssi_dir); command 'layout save'; command 'save'; @@ -71,33 +71,30 @@ sub upgrade { sub restore { my $fn = _filename; - open my $fh, q{<}, $fn or die "open $fn: $!"; + my $in = retrieve($fn) or die "Could not retrieve data from $fn"; unlink $fn or warn "unlink $fn: $!"; - - my @suppress = split /\0/, readline $fh; - if (settings_get_bool 'upgrade_suppress_join') { - chomp $suppress[-1]; - @suppress{@suppress} = (2) x @suppress; - } + + my @suppress = @{$in->{suppress}}; + @suppress{@suppress} = (2) x @suppress if (settings_get_bool 'upgrade_suppress_join'); + active_win->command('^window scroll off'); - while (my $bla = readline $fh){ - chomp $bla; - my ($refnum, $lines) = split /:/, $bla; - next unless $lines; - my $window = window_find_refnum $refnum; - unless (defined $window){ - readline $fh for 1..$lines; - next; - } - my $view = $window->view; - $view->remove_all_lines(); - $view->redraw(); - my $buf = ''; - $buf .= readline $fh for 1..$lines; - my $sep = settings_get_str 'upgrade_separator'; - $sep .= "\n" if $sep ne ''; - $window->gui_printtext_after(undef, MSGLEVEL_CLIENTNOTICE, "$buf\cO$sep"); - $view->redraw(); + for my $win (@{$in->{windows}}) { + my $window = window_find_refnum $win->{refnum}; + next unless $window; + my @lines = @{ $win->{lines} || [] }; + next unless @lines; + + my $view = $window->view; + $view->remove_all_lines(); + $view->redraw(); + for my $line (@lines) { + my $level = $line->{level}; + my $data = $line->{data}; + $window->gui_printtext_after($window->last_line_insert, $level, "$data\n"); + } + my $sep = settings_get_str 'upgrade_separator'; + $window->gui_printtext_after($window->last_line_insert, MSGLEVEL_CLIENTNOTICE, "\cO$sep\n") if $sep ne ''; + $view->redraw(); } active_win->command('^window scroll on'); active_win->command('^scrollback end'); @@ -110,7 +107,7 @@ sub suppress { $key_part =~ s/^://; my $key = $first->{address} . $key_part; if (exists $suppress{$key} and $suppress{$key}--) { - signal_stop(); + signal_stop(); delete $suppress{$key} unless $suppress{$key}; } } diff --git a/scripts/dns.pl b/scripts/dns.pl index 989cdc3e..9e9f4789 100644 --- a/scripts/dns.pl +++ b/scripts/dns.pl @@ -1,16 +1,18 @@ # /DNS || ... -# version 2.1.1 -# -# updated the script to fix a bug where the script would let -# a trailing whitespace go through (ex: tab completion) -# - inch +# +# v2.2 +# add ipv6 support +# v2.1.1 +# updated the script to fix a bug where the script would let +# a trailing whitespace go through (ex: tab completion) +# - inch use strict; use Socket; use POSIX; use vars qw($VERSION %IRSSI); -$VERSION = "2.1.1"; +$VERSION = "2.2"; %IRSSI = ( authors => "Timo \'cras\' Sirainen", contact => "tss\@iki.fi", @@ -18,7 +20,7 @@ $VERSION = "2.1.1"; description => "/DNS || ...", license => "Public Domain", url => "http://irssi.org/", - changed => "2002-03-04T22:47+0100" + changed => "2019-01-24" ); my (%resolve_hosts, %resolve_nicks, %resolve_print); # resolve queues @@ -102,6 +104,42 @@ sub sig_userhost { host_lookup() if (!$lookup_waiting); } +sub dns { + my ($host) =@_; + my %hints = (socktype => SOCK_STREAM); + my ($err, @res) = Socket::getaddrinfo($host, "http", \%hints); + my @res1; + if ($err ==0 ) { + foreach(@res) { + if ($_->{family}==AF_INET) { + my ($proto,$ip)=unpack_sockaddr_in($_->{addr}); + push @res1, Socket::inet_ntop(AF_INET,$ip); + } + if ($_->{family}==AF_INET6) { + my ($proto,$ip)=unpack_sockaddr_in6($_->{addr}); + push @res1, Socket::inet_ntop(AF_INET6,$ip); + } + } + return join(' ',@res1); + } +} + +sub rdns { + my ($host) =@_; + my %hints = (socktype => SOCK_STREAM); + my ($err, @res) = Socket::getaddrinfo($host, "http", \%hints); + my @res1; + if ($err ==0 ) { + foreach(@res) { + my ($err, $hostname, $servicename) = Socket::getnameinfo $_->{addr}; + if ($err ==0) { + push @res1, $hostname; + } + } + return join(' ',@res1); + } +} + sub host_lookup { return if (!%resolve_hosts); @@ -145,16 +183,13 @@ sub host_lookup { eval { # child, do the lookup my $name = ""; - if ($host =~ /^[0-9\.]*$/) { + if ($host =~ /^[0-9\.]*$/ || $host =~ m/^[0-9a-f:]*$/) { # ip -> host - $name = gethostbyaddr(inet_aton($host), AF_INET); + #$name = gethostbyaddr(inet_aton($host), AF_INET); + $name = rdns($host); } else { # host -> ip - my @addrs = gethostbyname($host); - if (@addrs) { - @addrs = map { inet_ntoa($_) } @addrs[4 .. $#addrs]; - $name = join (" ", @addrs); - } + $name = dns($host); } $print_name = $input_query if !$print_name; @@ -197,3 +232,5 @@ Irssi::command_bind('dns', 'cmd_dns'); Irssi::signal_add( { 'redir dns failure' => \&sig_failure, 'redir dns host' => \&sig_userhost } ); + +# vim:set sw=2 ts=8: diff --git a/scripts/examples/Makefile.am b/scripts/examples/Makefile.am deleted file mode 100644 index c8d8c8e0..00000000 --- a/scripts/examples/Makefile.am +++ /dev/null @@ -1,8 +0,0 @@ -scriptdir = $(datadir)/irssi/scripts - -script_DATA = \ - command.pl \ - msg-event.pl \ - redirect.pl - -EXTRA_DIST = $(script_DATA) diff --git a/scripts/mail.pl b/scripts/mail.pl index 190c33af..bf14503a 100644 --- a/scripts/mail.pl +++ b/scripts/mail.pl @@ -1,11 +1,12 @@ use strict; use vars qw($VERSION %IRSSI); -$VERSION = "2.92"; +$VERSION = "2.93"; %IRSSI = ( authors => "Timo Sirainen, Matti Hiljanen, Joost Vunderink, Bart Matthaei", contact => "tss\@iki.fi, matti\@hiljanen.com, joost\@carnique.nl, bart\@dreamflow.nl", name => "mail", description => "Fully customizable mail counter statusbar item with multiple mailbox and multiple Maildir support", + sbitems => "mail", license => "Public Domain", url => "http://irssi.org, http://scripts.irssi.de", ); @@ -30,6 +31,7 @@ $VERSION = "2.92"; # Check /mailbox help for help. use Irssi::TextUI; +use Irssi; my $maildirmode = 0; # maildir=1, file(spools)=0 my $old_is_not_new = 0; @@ -37,7 +39,7 @@ my $extprog; my ($last_refresh_time, $refresh_tag); # for mbox caching -my $last_size, $last_mtime, $last_mailcount, $last_mode; +my ($last_size, $last_mtime, $last_mailcount, $last_mode); # list of mailboxes my %mailboxes = (); @@ -61,8 +63,8 @@ sub cmd_print_help { "/MAILBOX SHOW\n". " - Shows a list of the defined mailboxes.\n\n". "Use the following commands to change the behaviour:\n\n". - "/SET MAILDIRMODE on|off\n". - " - If maildirmode is on, the mailboxes in the list are assumed to be ". + "/SET MAILDIR_MODE on|off\n". + " - If maildir_mode is on, the mailboxes in the list are assumed to be ". "directories. Otherwise they are assumed to be spool files.\n". " Default: off.\n". "/SET MAIL_OLDNOTNEW on|off\n". @@ -101,8 +103,9 @@ sub mbox_count { my $old_is_not_new=Irssi::settings_get_bool('mail_oldnotnew'); if ($extprog ne "") { - $total = `$extprog`; - chomp $unread; + my $total = `$extprog`; + chomp $total; + ($read, $unread) = split ' ', $total, 2; } else { if (!$maildirmode) { if (-f $mailfile) { @@ -115,8 +118,7 @@ sub mbox_count { $last_size = $size; $last_mtime = $mtime; - my $f = gensym; - return 0 if (!open($f, "<", $mailfile)); + return 0 if (!open(my $f, "<", $mailfile)); # count new mails only my $internal_removed = 0; @@ -205,7 +207,7 @@ sub mail { my $total = 0; # check all mailboxes for new email - foreach $name (keys(%mailboxes)) { + foreach my $name (keys(%mailboxes)) { my $box = $mailboxes{$name}; # replace "~/" at the beginning by the user's home dir $box =~ s/^~\//$ENV{'HOME'}\//; @@ -233,7 +235,7 @@ sub mail { # Show this only if there are any new, unread messages. if (Irssi::settings_get_bool('mail_show_message') && $unread > $new_mails_in_box{$name}) { - $new_mails = $unread - $new_mails_in_box{$name}; + my $new_mails = $unread - $new_mails_in_box{$name}; if ($nummailboxes == 1) { Irssi::print("You have $new_mails new message" . ($new_mails != 1 ? "s." : "."), MSGLEVEL_CRAP); } else { @@ -263,11 +265,9 @@ sub add_mailboxes { my $boxstring = $_[0]; my @boxes = split(/,/, $boxstring); - foreach $dbox(@boxes) { - my $name = $dbox; - $name = substr($dbox, 0, index($dbox, '=')); - my $box = $dbox; - $box = substr($dbox, index($dbox, '=') + 1, length($dbox)); + foreach my $dbox(@boxes) { + my $name = substr($dbox, 0, index($dbox, '=')); + my $box = substr($dbox, index($dbox, '=') + 1, length($dbox)); addmailbox($name, $box); } } @@ -306,7 +306,7 @@ sub delmailbox { sub update_settings_string { my $setting; - foreach $name (keys(%mailboxes)) { + foreach my $name (keys(%mailboxes)) { $setting .= $name . "=" . $mailboxes{$name} . ","; } @@ -345,7 +345,7 @@ sub cmd_showmailboxes { return; } Irssi::print("Mailboxes:", MSGLEVEL_CRAP); - foreach $box (keys(%mailboxes)) { + foreach my $box (keys(%mailboxes)) { Irssi::print("$box: " . $mailboxes{$box}, MSGLEVEL_CRAP); } } diff --git a/scripts/meson.build b/scripts/meson.build new file mode 100644 index 00000000..10fdc34b --- /dev/null +++ b/scripts/meson.build @@ -0,0 +1,15 @@ +install_data( + files( + 'autoop.pl', + 'autorejoin.pl', + 'buf.pl', + 'dns.pl', + 'kills.pl', + 'mail.pl', + 'mlock.pl', + 'quitmsg.pl', + 'scriptassist.pl', + 'usercount.pl', + ), + install_dir : scriptdir, +) diff --git a/scripts/quitmsg.pl b/scripts/quitmsg.pl index e289468c..102d9aa5 100644 --- a/scripts/quitmsg.pl +++ b/scripts/quitmsg.pl @@ -6,36 +6,27 @@ use Irssi::Irc; use strict; use vars qw($VERSION %IRSSI); -$VERSION = "1.00"; +$VERSION = "1.01"; %IRSSI = ( authors => 'Timo Sirainen', name => 'quitmsg', description => 'Random quit messages', license => 'Public Domain', - changed => 'Sun Mar 10 23:18 EET 2002' + changed => 'Mon Jul 22 20:00 EET 2020' ); -my $quitfile = glob "~/.irssi/irssi.quit"; +my $quitfile = Irssi::get_irssi_dir() . "/irssi.quit"; sub cmd_quit { my ($data, $server, $channel) = @_; return if ($data ne ""); + + open (my $fh, "<", $quitfile) || return; + my @lines = <$fh>; - open (f, "<", $quitfile) || return; - my $lines = 0; while() { $lines++; }; - - my $line = int(rand($lines))+1; - - my $quitmsg; - seek(f, 0, 0); $. = 0; - while() { - next if ($. != $line); - - chomp; - $quitmsg = $_; - last; - } - close(f); + my $quitmsg = $lines[int(rand(@lines))]; + chomp($quitmsg); + close($fh); foreach my $server (Irssi::servers) { $server->command("/disconnect ".$server->{tag}." $quitmsg"); diff --git a/scripts/scriptassist.pl b/scripts/scriptassist.pl index 459d97f6..665615db 100644 --- a/scripts/scriptassist.pl +++ b/scripts/scriptassist.pl @@ -5,30 +5,35 @@ use strict; -our $VERSION = '2003020804'; +our $VERSION = '2023111700'; our %IRSSI = ( authors => 'Stefan \'tommie\' Tomanek', contact => 'stefan@pico.ruhr.de', name => 'scriptassist', description => 'keeps your scripts on the cutting edge', license => 'GPLv2', - url => 'http://irssi.org/scripts/', - modules => 'Data::Dumper LWP::UserAgent (GnuPG)', + url => 'https://scripts.irssi.org/', + modules => 'CPAN::Meta::YAML LWP::Protocol::https (GnuPG)', commands => "scriptassist" ); our ($forked, %remote_db, $have_gpg, @complist); use Irssi 20020324; -use Data::Dumper; +use CPAN::Meta::YAML; use LWP::UserAgent; +use Hash::Util qw(lock_ref_keys); +use JSON::PP; use POSIX; +use version; # GnuPG is not always needed $have_gpg = 0; eval "use GnuPG qw(:algo :trust);"; $have_gpg = 1 if not ($@); +my $irssi_version = qv('v'.Irssi::parse_special('$J') =~ s/[^.\d].*//r); + sub show_help { my $help = "scriptassist $VERSION /scriptassist check @@ -39,15 +44,15 @@ sub show_help { Search the script database /scriptassist info Display information about -".#/scriptassist ratings -# Retrieve the average ratings of the the scripts -#/scriptassist top -# Retrieve the first top rated scripts -"/scriptassist new +/scriptassist ratings + Retrieve the average ratings of the scripts +/scriptassist top + Retrieve the first top rated scripts +/scriptassist new Display the newest scripts -".#/scriptassist rate )?\s*((\r?\n)*\s*\s*)?(\s*){0,3})}{\1\2}g; +s{}{}g; +s{(.*?)}{\1}g;' + +srcdir=`dirname "$0"` +test -z "$srcdir" && srcdir=. +srcdir="$srcdir"/.. + +if test ! -f "$srcdir"/irssi.conf; then + echo -n "**Error**: Directory \`$srcdir' does not look like the" + echo " top-level $PKG_NAME directory" + exit 1 +fi + +# detect downloader app +downloader=false + +if type curl >/dev/null 2>&1 ; then + downloader="curl -Ssf" +elif type wget >/dev/null 2>&1 ; then + downloader="wget -nv -O-" +else + echo "**Error**: No wget or curl present" + echo "Install wget or curl, then run syncdocs.sh again" +fi + +# detect html converter app +converter=false +if [ "$1" = "-any" ]; then + any=true +else + any=false +fi + +addheadermark="perl -p -e s{\\K}{(q:#:x\$1).q: :}ge;s{(?=)}{q: :.(q:#:x\$1)}ge" +if type w3m >/dev/null 2>&1 ; then + converter="w3m -o display_link_number=1 -dump -T text/html" + any=true +elif type lynx >/dev/null 2>&1 ; then + converter="lynx -dump -stdin -force_html" +elif type elinks >/dev/null 2>&1 ; then + converter="elinks -dump -force-html" +else + echo "**Error**: Neither w3m, nor lynx or elinks present" + echo "Install w3m, then run syncdocs.sh again" + exit 1 +fi + +if ! $any ; then + echo "**Error**: w3m not present" + echo "If you want to use lynx or elinks, run syncdocs.sh -any" + exit 1 +fi + +check_download() { + if test "$1" -ne 0 || test ! -e "$2" || test "$(wc -l "$2" | awk '{print $1}')" -le 1 ; then + rm -f "$2" + echo "... download failed ( $1 )" + exit 2 + fi +} + +download_it() { + echo "Downloading $1 from $2 ..." + ret=0 + $downloader "$2" > "$3".tmp || ret=$? + check_download "$ret" "$3".tmp + perl -i -0777 -p -e "$pageclean_regex" "$3".tmp + perl -i -0777 -p -e 's{\A}{'""'\n}' "$3".tmp + perl -i -0777 -p -e 's{\[email protected\]}{user\@host}g' "$3".tmp + mv "$3".tmp "$3" +} + +download_it_nested() { + name=$1; shift + src=$1; shift + dest=$1; shift + download_it "$name" "$src" "$dest".nest + echo > "$dest" + eval $(perl -n -0777 -e 'print qq{download_it "\$name ($2)" "\${src}$1/" "\${dest}.$1"; +cat "\${dest}.$1" >> "\${dest}.tmp"; +rm "\${dest}.$1";\n} + while(m{(.*?)}g)' "$dest".nest) + rm "$dest".nest + perl -i -0777 -p -e 's{}{}g;s{\A}{\n}' "$dest".tmp + mv "$dest".tmp "$dest" +} + +download_it_nested "QNA" "$qna" "$srcdir"/docs/qna.html +download_it "New users guide" "$howto" "$srcdir"/docs/New-users.html +#download_it "Design" "$design" "$srcdir"/docs/design.html + +# .html -> .txt with lynx or elinks +echo "Documentation: html -> txt... [converter: $converter]" + +cat "$srcdir"/docs/qna.html \ + | $addheadermark | $converter > "$srcdir"/docs/qna.txt + +cat "$srcdir"/docs/New-users.html \ + | $addheadermark | $converter > "$srcdir"/docs/New-users.txt + +#cat "$srcdir"/docs/design.html \ +# | $addheadermark | $converter > "$srcdir"/docs/design.txt diff --git a/utils/syncscripts.sh b/utils/syncscripts.sh new file mode 100755 index 00000000..5df1d036 --- /dev/null +++ b/utils/syncscripts.sh @@ -0,0 +1,39 @@ +#!/bin/sh -e +# Run this script to sync dual lived scripts from scripts.irssi.org to scripts/ + +PKG_NAME="Irssi" + +scriptbase=https://scripts.irssi.org/scripts + +srcdir=`dirname "$0"` +test -z "$srcdir" && srcdir=. +srcdir="$srcdir"/.. + +if test ! -f "$srcdir"/irssi.conf; then + echo -n "**Error**: Directory \`$srcdir' does not look like the" + echo " top-level $PKG_NAME directory" + exit 1 +fi + +dl2='curl -Ssf' + +dl_it() { + echo "$1" + $dl2 -o "$srcdir/scripts/$1" "$scriptbase/$1" +} + +for script in \ + autoop.pl \ + autorejoin.pl \ + buf.pl \ + dns.pl \ + kills.pl \ + mail.pl \ + mlock.pl \ + quitmsg.pl \ + scriptassist.pl \ + usercount.pl \ + ; +do + dl_it $script +done diff --git a/syntax.pl b/utils/syntax.pl similarity index 98% rename from syntax.pl rename to utils/syntax.pl index 33bd12b4..42a4accb 100755 --- a/syntax.pl +++ b/utils/syntax.pl @@ -39,6 +39,7 @@ foreach $file (@files) { } while () { next if (/Makefile/); + next if (/meson\.build/); open (FILE, "$_"); @data = ;