Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 104 additions & 101 deletions src/content/docs/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,101 +1,104 @@
---
title: Quick Start
---

import { Aside, CardGrid, Card } from '@astrojs/starlight/components';

### Connect First Time

<CardGrid>

<Card>

Click on the IBM i icon and then on 'Connect to an IBM i'.

</Card><Card>

![](../../assets/connect_02.png)

</Card></CardGrid>

---

<CardGrid>
<Card>
Enter the systems details in the window that appears. You need either a password or a private key.

Alternatively, press <kbd>F1</kbd>, search for `IBM i: New Connection`, and complete the form.
</Card>
<Card>
![](../../assets/connect_03.png)
</Card>
</CardGrid>

### Connect Subsequent

<CardGrid>
<Card>
If you have already connected to an IBM i system, click on the conection in the IBM i: Servers browser.
</Card>
<Card>
![](../../assets/connect_04.png)
</Card>
</CardGrid>

<CardGrid>
<Card>
After logging in, a status bar item will appear showing the name of the IBM i system to which you are connected.
</Card>
<Card>
![assets/connect_05.png](../../assets/connect_05.png)
</Card>
</CardGrid>

### Logout (Disconnect)
You can close a connection and logout out from a server in several ways
<CardGrid>

<Card>
Use the keyboard: <kbd>Ctrl(Cmd)</kbd> + <kbd>Alt</kbd > + <kbd>D</kbd>
</Card>
<Card>
</Card>
<Card>
Click the `Disconnect from system` icon in the status bar...
</Card>
<Card>
![Dicconnect icon](../../assets/connect_08.png)
</Card>
<Card>
Press <kbd>F1</kbd> and search for `IBM i: Disconnect`
</Card>
<Card>
![Search Disconnect](../../assets/connect_07.png)
</Card>

</CardGrid>

---

### Browse/Edit source members

1. Connect to your system.
2. Find the **Object Browser** and click **+ Create new filter**.
3. Complete the new filter dialog, following the descriptive text, ensuring:
a. That **Object** is the source physical file you want to edit.
b. That **Object type filter** is set to `*SRCPF`.
4. Save settings
5. Click on the filter to expand the members in the source file.
6. Click on a member to open it.

<Aside type="note">
There is no member locking and the extension defaults to not retaining source dates.
</Aside>

### How do I compile my source code?

1. Edit your library list in the 'USER LIBRARY LIST' browser. (Each connection has its own library list.)
2. Open the source you want to compile.
3. Use <kbd>Ctrl+E</kbd> or <kbd>Cmd+E</kbd> to compile your source.
4. If you have more than one compile option available to you for the type of source, select the appropriate one.
5. If you are using `*EVENTF`, the error listing should automatically load in the PROBLEMS tab.
---
title: Quick Start
---

import { Aside, CardGrid, Card } from '@astrojs/starlight/components';

### Connect First Time

<CardGrid>

<Card>

Click on the IBM i icon and then on 'Connect to an IBM i'.

</Card><Card>

![](../../assets/connect_02.png)

</Card></CardGrid>

---

<CardGrid>
<Card>
Enter the systems details in the window that appears. You need either a password or a private key.

Alternatively, press <kbd>F1</kbd>, search for `IBM i: New Connection`, and complete the form.
<Aside type="note">
If you have multi-factor authentication (MFA) enabled on your IBM i, make sure to select the `Enable Multi-Factor Authentication (MFA)` option. When enabled, this will prompt you for your one-time password when attempting to connect. Enter your TOTP in this prompt or press "Enter" if within your TOTP interval.
</Aside>
</Card>
<Card>
![](../../assets/connect_03.png)
</Card>
</CardGrid>

### Connect Subsequent

<CardGrid>
<Card>
If you have already connected to an IBM i system, click on the conection in the IBM i: Servers browser.
</Card>
<Card>
![](../../assets/connect_04.png)
</Card>
</CardGrid>

<CardGrid>
<Card>
After logging in, a status bar item will appear showing the name of the IBM i system to which you are connected.
</Card>
<Card>
![assets/connect_05.png](../../assets/connect_05.png)
</Card>
</CardGrid>

### Logout (Disconnect)
You can close a connection and logout out from a server in several ways
<CardGrid>

<Card>
Use the keyboard: <kbd>Ctrl(Cmd)</kbd> + <kbd>Alt</kbd > + <kbd>D</kbd>
</Card>
<Card>
</Card>
<Card>
Click the `Disconnect from system` icon in the status bar...
</Card>
<Card>
![Dicconnect icon](../../assets/connect_08.png)
</Card>
<Card>
Press <kbd>F1</kbd> and search for `IBM i: Disconnect`
</Card>
<Card>
![Search Disconnect](../../assets/connect_07.png)
</Card>

</CardGrid>

---

### Browse/Edit source members

1. Connect to your system.
2. Find the **Object Browser** and click **+ Create new filter**.
3. Complete the new filter dialog, following the descriptive text, ensuring:
a. That **Object** is the source physical file you want to edit.
b. That **Object type filter** is set to `*SRCPF`.
4. Save settings
5. Click on the filter to expand the members in the source file.
6. Click on a member to open it.

<Aside type="note">
There is no member locking and the extension defaults to not retaining source dates.
</Aside>

### How do I compile my source code?

1. Edit your library list in the 'USER LIBRARY LIST' browser. (Each connection has its own library list.)
2. Open the source you want to compile.
3. Use <kbd>Ctrl+E</kbd> or <kbd>Cmd+E</kbd> to compile your source.
4. If you have more than one compile option available to you for the type of source, select the appropriate one.
5. If you are using `*EVENTF`, the error listing should automatically load in the PROBLEMS tab.