From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 973CFA0471 for ; Mon, 12 Aug 2019 09:13:00 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 90EE037A8; Mon, 12 Aug 2019 09:13:00 +0200 (CEST) Received: from mail-pf1-f175.google.com (mail-pf1-f175.google.com [209.85.210.175]) by dpdk.org (Postfix) with ESMTP id A5BB137A8 for ; Mon, 12 Aug 2019 09:12:59 +0200 (CEST) Received: by mail-pf1-f175.google.com with SMTP id o70so3910276pfg.5 for ; Mon, 12 Aug 2019 00:12:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:in-reply-to:references; bh=oRh3kt+G/sqGwZ9ae6Blx9rwpsbP/BCLC6VM33zwiwI=; b=iweTUHXmL6ItX5QShvvrhQw2Qgmm4YJ5tH+GT0z7jDWGuJ7QwCDNYw7SD1YhSE9Gyw F0WhhJMQpcdSGq/dMbsRrOBV7IZtpZCnRr6xAq02tT8+y5is3+qfZaIpmqqQn/jQ3808 V1Y5kg5J0hj7xgj5ES8Wiiyjn/0pbCj2TCXFs2VCNgV/jQNkOR7FpR5td4X8yRWtTB8+ ABzs/adRGBnIb08rUjv+rKWOnrmS2/F3ijlzvl028m4+CwWu5PWpwTUZmnXH5KFoPvTw Ub+fecJWztY9iFUZylTiaNBBLesXvv/VK5zAUTudjdT5Ahubz6jSp+tqM0y9KVB/u4kd t2Ng== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=oRh3kt+G/sqGwZ9ae6Blx9rwpsbP/BCLC6VM33zwiwI=; b=g2uGQtJeeuM3lOpjowTdGyNLQpzuIj+qVWUtptqWCxKD/VQ3gApdF9GfUNxNbhzVRT 2r3ffEHw07/K+e7+XHxY1Ggcl7OEdIrr+aRpYxGcWXBSfx5LsbMLvTdA63xGDjbJNjtb 3orX7FGLaif2sojqe7uJKNUfK4QUQkHZlWRtD2npx2m79fE20v3mg/kt/4RqXR/paOUZ uUBu7r2i2MwtD1XBELqr+exKiMl6RifaRNdi69zFsf8i60eOrqSyzmgfNzhbQeeaJDz8 4+ofX6cudqx9apv04F+cFlGKOmxz4TT49NFGLQ9Jjmru0o6rMtGyeuhRBLGZZ+5AaPE0 52JQ== X-Gm-Message-State: APjAAAU0FgsW6LlpMh4GRYap4aoyLNZNXpvi8YEDRThiJzHcFiYrnAs2 aUdV9MbftBpXF3v0wlKYfkjUIGjI X-Google-Smtp-Source: APXvYqxY7T6+jxVwpagOjcJzzqRUnAvHgzEYJbPFdRPxxMUqR22wI6XOS00M1L/7+CnbmDtcLYxzAA== X-Received: by 2002:a63:7a06:: with SMTP id v6mr29422343pgc.115.1565593978723; Mon, 12 Aug 2019 00:12:58 -0700 (PDT) Received: from localhost.localdomain ([2400:4050:c8c2:de00:8000:cb51:dfcb:76c]) by smtp.gmail.com with ESMTPSA id h9sm94675326pgh.51.2019.08.12.00.12.57 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Mon, 12 Aug 2019 00:12:58 -0700 (PDT) From: Yasufumi Ogawa To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Mon, 12 Aug 2019 16:12:42 +0900 Message-Id: <20190812071242.18934-9-yasufum.o@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190812071242.18934-1-yasufum.o@gmail.com> References: <20190812071242.18934-1-yasufum.o@gmail.com> Subject: [spp] [PATCH 8/8] cli: revise description for imgcat X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: spp-bounces@dpdk.org Sender: "spp" This update is to revise how to setup 3rd party tool `imgcat` for iTerm2 on MacOS. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/experimental.rst | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/guides/commands/experimental.rst b/docs/guides/commands/experimental.rst index 576d11e..c328c73 100644 --- a/docs/guides/commands/experimental.rst +++ b/docs/guides/commands/experimental.rst @@ -27,7 +27,7 @@ Support four types of output. This command uses `graphviz `_ -gfor generating topology file. +for generating topology file. You can also generate a dot formatted file or image files supported by graphviz. @@ -40,8 +40,9 @@ to output in a terminal. imagemagick \ libsixel-bin -MacOS is also supported optionally for using SPP CLI runs on a remote host. -In this case, iTerm2 and imgcat are required. +MacOS is also supported optionally for using topo runs on a remote host. +In this case, iTerm2 and imgcat are required as described in the next +section. To output in browser with ``topo http`` command, install required packages by using ``requirements.txt`` as described in @@ -62,16 +63,18 @@ Output an image of network configuration in terminal. spp > topo term -There are few terminal applications to output image with ``topo``. +There are few terminal applications supporting to output image with ``topo``. You can use mlterm, xterm or other terminals supported by `img2sixel `_. You can also use `iTerm2 `_ on MacOS. -If you use iTerm2, you have to get a shell script +If you use iTerm2, you need to downloada a shell script ``imgcat`` from `iTerm2's displaying support site `_ and save this script as -``spp/src/controller/3rd_party/imgcat``. +``src/controller/3rd_party/imgcat`` with permission ``775``. +``topo`` command tries to ``img2sixel`` first, then ``imgcat`` +in the ``3rd_party`` directory. .. _figure_topo_term_exp: -- 2.17.1