components/python/pylint/manpages/symilar.1
author Rich Burridge <rich.burridge@oracle.com>
Fri, 31 Mar 2017 07:26:17 -0700
changeset 7820 a2b9a7de9e1a
parent 4814 c673d998018a
permissions -rw-r--r--
25795430 Adjust Userland man pages to "5.11" (from "5.12") where needed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4814
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     1
'\" te
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     2
.\"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     3
.\" CDDL HEADER START
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     4
.\"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     5
.\" The contents of this file are subject to the terms of the
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     6
.\" Common Development and Distribution License (the "License").
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     7
.\" You may not use this file except in compliance with the License.
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     8
.\"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
     9
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    10
.\" or http://www.opensolaris.org/os/licensing.
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    11
.\" See the License for the specific language governing permissions
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    12
.\" and limitations under the License.
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    13
.\"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    14
.\" When distributing Covered Code, include this CDDL HEADER in each
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    15
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    16
.\" If applicable, add the following below this CDDL HEADER, with the
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    17
.\" fields enclosed by brackets "[]" replaced with your own identifying
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    18
.\" information: Portions Copyright [yyyy] [name of copyright owner]
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    19
.\"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    20
.\" CDDL HEADER END
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    21
.\"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    22
.\"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    23
.\" Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    24
.\"
7820
a2b9a7de9e1a 25795430 Adjust Userland man pages to "5.11" (from "5.12") where needed
Rich Burridge <rich.burridge@oracle.com>
parents: 4814
diff changeset
    25
.TH symilar 1 "10 Jun 2015" "SunOS 5.11"
4814
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    26
.SH NAME
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    27
.B symilar
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    28
\- finds copy pasted blocks in a set of files
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    29
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    30
.SH SYNOPSIS
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    31
.B /usr/bin/symilar
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    32
[
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    33
.I OPTIONS
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    34
]  file...
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    35
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    36
.SH DESCRIPTION
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    37
.B symilar
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    38
is a helper script for pylint. Symilar will display information
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    39
about duplicate lines in a file.  The output lists the total number of lines,
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    40
how many duplicate lines found and what percentage of the lines are duplicates.
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    41
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    42
.SH OPTIONS
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    43
.IP "--duplicates, -dl  min_duplicated_line"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    44
sets a minimum threshhold for duplicated lines
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    45
.IP "--help, -h"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    46
displays help message 
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    47
.IP "--ignore-comments"
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    48
do not include duplicates found in comment blocks
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    49
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    50
.SH USAGE
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    51
symilar [-d|--duplicates min_duplicated_lines] [-i|--ignore-comments] [--ignore-docstrings] [--ignore-imports] file1..
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    52
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    53
.SH FILES
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    54
/usr/lib/python2.7/vendor-packages/pylint
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    55
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    56
.SH SUPPORT
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    57
[email protected]
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    58
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    59
.SH SEE ALSO
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    60
.IR pylint (1),
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    61
.IR logilab-common (3), 
c673d998018a PSARC 2015/302 astroid 1.3.6
Yiteng Zhang <yiteng.zhang@oracle.com>
parents:
diff changeset
    62
.IR astroid (3)